Package com.commercetools.api.models.cart

Class CartPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.cart.CartPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<CartPagedQueryResponse>

public class CartPagedQueryResponseBuilder
extends Object
implements Builder<CartPagedQueryResponse>

CartPagedQueryResponseBuilder Example to create an instance using the builder pattern

     CartPagedQueryResponse cartPagedQueryResponse = CartPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CartPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
CartPagedQueryResponseBuilder	addResults(Function<CartBuilder,Cart> builder)	Carts matching the query.
CartPagedQueryResponse	build()	builds CartPagedQueryResponse with checking for non-null required values
CartPagedQueryResponse	buildUnchecked()	builds CartPagedQueryResponse without checking for non-null required values
CartPagedQueryResponseBuilder	count(Long count)	Actual number of results returned.
Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
List<Cart>	getResults()	Carts matching the query.
Long	getTotal()	Total number of results matching the query.
CartPagedQueryResponseBuilder	limit(Long limit)	Number of results requested.
static CartPagedQueryResponseBuilder	of()	factory method for an instance of CartPagedQueryResponseBuilder
static CartPagedQueryResponseBuilder	of(CartPagedQueryResponse template)	create builder for CartPagedQueryResponse instance
CartPagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
CartPagedQueryResponseBuilder	plusResults(Cart... results)	Carts matching the query.
CartPagedQueryResponseBuilder	plusResults(Function<CartBuilder,CartBuilder> builder)	Carts matching the query.
CartPagedQueryResponseBuilder	results(Cart... results)	Carts matching the query.
CartPagedQueryResponseBuilder	results(List<Cart> results)	Carts matching the query.
CartPagedQueryResponseBuilder	setResults(Function<CartBuilder,Cart> builder)	Carts matching the query.
CartPagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
CartPagedQueryResponseBuilder	withResults(Function<CartBuilder,CartBuilder> builder)	Carts matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

CartPagedQueryResponseBuilder

public CartPagedQueryResponseBuilder()

Method Details

limit

public CartPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public CartPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public CartPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public CartPagedQueryResponseBuilder total(@Nullable
 Long total)

Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

Parameters:

total - value to be set

Returns:

Builder

results

public CartPagedQueryResponseBuilder results(Cart... results)

Carts matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public CartPagedQueryResponseBuilder results(List<Cart> results)

Carts matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CartPagedQueryResponseBuilder plusResults(Cart... results)

Carts matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CartPagedQueryResponseBuilder plusResults(Function<CartBuilder,CartBuilder> builder)

Carts matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public CartPagedQueryResponseBuilder withResults(Function<CartBuilder,CartBuilder> builder)

Carts matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public CartPagedQueryResponseBuilder addResults(Function<CartBuilder,Cart> builder)

Carts matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public CartPagedQueryResponseBuilder setResults(Function<CartBuilder,Cart> builder)

Carts matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Long getLimit()

Number of results requested.

Returns:

limit

getOffset

public Long getOffset()

Number of elements skipped.

Returns:

offset

getCount

public Long getCount()

Actual number of results returned.

Returns:

count

getTotal

@Nullable
public Long getTotal()

Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

Returns:

total

getResults

public List<Cart> getResults()

Carts matching the query.

Returns:

results

build

public CartPagedQueryResponse build()

builds CartPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<CartPagedQueryResponse>

Returns:

CartPagedQueryResponse

buildUnchecked

public CartPagedQueryResponse buildUnchecked()

builds CartPagedQueryResponse without checking for non-null required values

Returns:

CartPagedQueryResponse

of

public static CartPagedQueryResponseBuilder of()

factory method for an instance of CartPagedQueryResponseBuilder

Returns:

builder

of

public static CartPagedQueryResponseBuilder of(CartPagedQueryResponse template)

create builder for CartPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder