Package com.commercetools.api.models.order

Class OrderPagedSearchResponseBuilder

java.lang.Object

com.commercetools.api.models.order.OrderPagedSearchResponseBuilder

All Implemented Interfaces:

Builder<OrderPagedSearchResponse>

public class OrderPagedSearchResponseBuilder
extends Object
implements Builder<OrderPagedSearchResponse>

OrderPagedSearchResponseBuilder Example to create an instance using the builder pattern

     OrderPagedSearchResponse orderPagedSearchResponse = OrderPagedSearchResponse.builder()
             .total(0.3)
             .plusHits(hitsBuilder -> hitsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderPagedSearchResponseBuilder()

Method Summary

Modifier and Type	Method	Description
OrderPagedSearchResponseBuilder	addHits(Function<HitBuilder,Hit> builder)	Actual results.
OrderPagedSearchResponse	build()	builds OrderPagedSearchResponse with checking for non-null required values
OrderPagedSearchResponse	buildUnchecked()	builds OrderPagedSearchResponse without checking for non-null required values
List<Hit>	getHits()	Actual results.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
Long	getTotal()	Total number of results matching the query.
OrderPagedSearchResponseBuilder	hits(Hit... hits)	Actual results.
OrderPagedSearchResponseBuilder	hits(List<Hit> hits)	Actual results.
OrderPagedSearchResponseBuilder	limit(Long limit)	Number of results requested.
static OrderPagedSearchResponseBuilder	of()	factory method for an instance of OrderPagedSearchResponseBuilder
static OrderPagedSearchResponseBuilder	of(OrderPagedSearchResponse template)	create builder for OrderPagedSearchResponse instance
OrderPagedSearchResponseBuilder	offset(Long offset)	Number of elements skipped.
OrderPagedSearchResponseBuilder	plusHits(Hit... hits)	Actual results.
OrderPagedSearchResponseBuilder	plusHits(Function<HitBuilder,HitBuilder> builder)	Actual results.
OrderPagedSearchResponseBuilder	setHits(Function<HitBuilder,Hit> builder)	Actual results.
OrderPagedSearchResponseBuilder	total(Long total)	Total number of results matching the query.
OrderPagedSearchResponseBuilder	withHits(Function<HitBuilder,HitBuilder> builder)	Actual results.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrderPagedSearchResponseBuilder

public OrderPagedSearchResponseBuilder()

Method Details

total

public OrderPagedSearchResponseBuilder total(Long total)

Total number of results matching the query.

Parameters:

total - value to be set

Returns:

Builder

offset

public OrderPagedSearchResponseBuilder offset(@Nullable
 Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

limit

public OrderPagedSearchResponseBuilder limit(@Nullable
 Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

hits

public OrderPagedSearchResponseBuilder hits(Hit... hits)

Actual results.

Parameters:

hits - value to be set

Returns:

Builder

hits

public OrderPagedSearchResponseBuilder hits(List<Hit> hits)

Actual results.

Parameters:

hits - value to be set

Returns:

Builder

plusHits

public OrderPagedSearchResponseBuilder plusHits(Hit... hits)

Actual results.

Parameters:

hits - value to be set

Returns:

Builder

plusHits

public OrderPagedSearchResponseBuilder plusHits(Function<HitBuilder,HitBuilder> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

withHits

public OrderPagedSearchResponseBuilder withHits(Function<HitBuilder,HitBuilder> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

addHits

public OrderPagedSearchResponseBuilder addHits(Function<HitBuilder,Hit> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

setHits

public OrderPagedSearchResponseBuilder setHits(Function<HitBuilder,Hit> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

getTotal

public Long getTotal()

Total number of results matching the query.

Returns:

total

getOffset

@Nullable
public Long getOffset()

Number of elements skipped.

Returns:

offset

getLimit

@Nullable
public Long getLimit()

Number of results requested.

Returns:

limit

getHits

public List<Hit> getHits()

Actual results.

Returns:

hits

build

public OrderPagedSearchResponse build()

builds OrderPagedSearchResponse with checking for non-null required values

Specified by:

build in interface Builder<OrderPagedSearchResponse>

Returns:

OrderPagedSearchResponse

buildUnchecked

public OrderPagedSearchResponse buildUnchecked()

builds OrderPagedSearchResponse without checking for non-null required values

Returns:

OrderPagedSearchResponse

of

public static OrderPagedSearchResponseBuilder of()

factory method for an instance of OrderPagedSearchResponseBuilder

Returns:

builder

of

public static OrderPagedSearchResponseBuilder of(OrderPagedSearchResponse template)

create builder for OrderPagedSearchResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder