Package com.commercetools.api.models.shopping_list

Class ShoppingListPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.shopping_list.ShoppingListPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ShoppingListPagedQueryResponse>

public class ShoppingListPagedQueryResponseBuilder
extends Object
implements Builder<ShoppingListPagedQueryResponse>

ShoppingListPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ShoppingListPagedQueryResponse shoppingListPagedQueryResponse = ShoppingListPagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ShoppingListPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
ShoppingListPagedQueryResponseBuilder	addResults(Function<ShoppingListBuilder,ShoppingList> builder)	ShoppingLists matching the query.
ShoppingListPagedQueryResponse	build()	builds ShoppingListPagedQueryResponse with checking for non-null required values
ShoppingListPagedQueryResponse	buildUnchecked()	builds ShoppingListPagedQueryResponse without checking for non-null required values
ShoppingListPagedQueryResponseBuilder	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<ShoppingList>	getResults()	ShoppingLists matching the query.
Long	getTotal()	Total number of results matching the query.
ShoppingListPagedQueryResponseBuilder	limit(Long limit)	Number of results requested.
static ShoppingListPagedQueryResponseBuilder	of()	factory method for an instance of ShoppingListPagedQueryResponseBuilder
static ShoppingListPagedQueryResponseBuilder	of(ShoppingListPagedQueryResponse template)	create builder for ShoppingListPagedQueryResponse instance
ShoppingListPagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
ShoppingListPagedQueryResponseBuilder	plusResults(ShoppingList... results)	ShoppingLists matching the query.
ShoppingListPagedQueryResponseBuilder	plusResults(Function<ShoppingListBuilder,ShoppingListBuilder> builder)	ShoppingLists matching the query.
ShoppingListPagedQueryResponseBuilder	results(ShoppingList... results)	ShoppingLists matching the query.
ShoppingListPagedQueryResponseBuilder	results(List<ShoppingList> results)	ShoppingLists matching the query.
ShoppingListPagedQueryResponseBuilder	setResults(Function<ShoppingListBuilder,ShoppingList> builder)	ShoppingLists matching the query.
ShoppingListPagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
ShoppingListPagedQueryResponseBuilder	withResults(Function<ShoppingListBuilder,ShoppingListBuilder> builder)	ShoppingLists matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

ShoppingListPagedQueryResponseBuilder

public ShoppingListPagedQueryResponseBuilder()

Method Details

limit

public ShoppingListPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

count

public ShoppingListPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ShoppingListPagedQueryResponseBuilder 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

offset

public ShoppingListPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

results

public ShoppingListPagedQueryResponseBuilder results(ShoppingList... results)

ShoppingLists matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ShoppingListPagedQueryResponseBuilder results(List<ShoppingList> results)

ShoppingLists matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ShoppingListPagedQueryResponseBuilder plusResults(ShoppingList... results)

ShoppingLists matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ShoppingListPagedQueryResponseBuilder plusResults(Function<ShoppingListBuilder,ShoppingListBuilder> builder)

ShoppingLists matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ShoppingListPagedQueryResponseBuilder withResults(Function<ShoppingListBuilder,ShoppingListBuilder> builder)

ShoppingLists matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ShoppingListPagedQueryResponseBuilder addResults(Function<ShoppingListBuilder,ShoppingList> builder)

ShoppingLists matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ShoppingListPagedQueryResponseBuilder setResults(Function<ShoppingListBuilder,ShoppingList> builder)

ShoppingLists matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Long getLimit()

Number of results requested.

Returns:

limit

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

getOffset

public Long getOffset()

Number of elements skipped.

Returns:

offset

getResults

public List<ShoppingList> getResults()

ShoppingLists matching the query.

Returns:

results

build

public ShoppingListPagedQueryResponse build()

builds ShoppingListPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ShoppingListPagedQueryResponse>

Returns:

ShoppingListPagedQueryResponse

buildUnchecked

public ShoppingListPagedQueryResponse buildUnchecked()

builds ShoppingListPagedQueryResponse without checking for non-null required values

Returns:

ShoppingListPagedQueryResponse

of

public static ShoppingListPagedQueryResponseBuilder of()

factory method for an instance of ShoppingListPagedQueryResponseBuilder

Returns:

builder

of

public static ShoppingListPagedQueryResponseBuilder of(ShoppingListPagedQueryResponse template)

create builder for ShoppingListPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder