Package com.commercetools.api.models.product_selection

Class ProductSelectionPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.product_selection.ProductSelectionPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ProductSelectionPagedQueryResponse>

public class ProductSelectionPagedQueryResponseBuilder
extends Object
implements Builder<ProductSelectionPagedQueryResponse>

ProductSelectionPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ProductSelectionPagedQueryResponse productSelectionPagedQueryResponse = ProductSelectionPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSelectionPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSelectionPagedQueryResponseBuilder

public ProductSelectionPagedQueryResponseBuilder()

Method Details

limit

public ProductSelectionPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ProductSelectionPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ProductSelectionPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ProductSelectionPagedQueryResponseBuilder total(@Nullable
 Long total)

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. 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 ProductSelectionPagedQueryResponseBuilder results(ProductSelection... results)

ProductSelections matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ProductSelectionPagedQueryResponseBuilder results(List<ProductSelection> results)

ProductSelections matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductSelectionPagedQueryResponseBuilder plusResults(ProductSelection... results)

ProductSelections matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductSelectionPagedQueryResponseBuilder plusResults(Function<ProductSelectionBuilder,ProductSelectionBuilder> builder)

ProductSelections matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ProductSelectionPagedQueryResponseBuilder withResults(Function<ProductSelectionBuilder,ProductSelectionBuilder> builder)

ProductSelections matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ProductSelectionPagedQueryResponseBuilder addResults(Function<ProductSelectionBuilder,ProductSelection> builder)

ProductSelections matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ProductSelectionPagedQueryResponseBuilder setResults(Function<ProductSelectionBuilder,ProductSelection> builder)

ProductSelections 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. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Returns:

total

getResults

public List<ProductSelection> getResults()

ProductSelections matching the query.

Returns:

results

build

public ProductSelectionPagedQueryResponse build()

builds ProductSelectionPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ProductSelectionPagedQueryResponse>

Returns:

ProductSelectionPagedQueryResponse

buildUnchecked

public ProductSelectionPagedQueryResponse buildUnchecked()

builds ProductSelectionPagedQueryResponse without checking for non-null required values

Returns:

ProductSelectionPagedQueryResponse

of

public static ProductSelectionPagedQueryResponseBuilder of()

factory method for an instance of ProductSelectionPagedQueryResponseBuilder

Returns:

builder

of

public static ProductSelectionPagedQueryResponseBuilder of(ProductSelectionPagedQueryResponse template)

create builder for ProductSelectionPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder