Package com.commercetools.api.models.product

Class ProductPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.product.ProductPagedQueryResponseBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<ProductPagedQueryResponse>

public class ProductPagedQueryResponseBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ProductPagedQueryResponse>

ProductPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ProductPagedQueryResponse productPagedQueryResponse = ProductPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProductPagedQueryResponseBuilder

public ProductPagedQueryResponseBuilder()

Method Details

limit

public ProductPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ProductPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ProductPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ProductPagedQueryResponseBuilder 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 ProductPagedQueryResponseBuilder results(Product... results)

Products matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ProductPagedQueryResponseBuilder results(List<Product> results)

Products matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductPagedQueryResponseBuilder plusResults(Product... results)

Products matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductPagedQueryResponseBuilder plusResults(Function<ProductBuilder,ProductBuilder> builder)

Products matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ProductPagedQueryResponseBuilder withResults(Function<ProductBuilder,ProductBuilder> builder)

Products matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ProductPagedQueryResponseBuilder addResults(Function<ProductBuilder,Product> builder)

Products matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ProductPagedQueryResponseBuilder setResults(Function<ProductBuilder,Product> builder)

Products 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<Product> getResults()

Products matching the query.

Returns:

results

build

public ProductPagedQueryResponse build()

builds ProductPagedQueryResponse with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<ProductPagedQueryResponse>

Returns:

ProductPagedQueryResponse

buildUnchecked

public ProductPagedQueryResponse buildUnchecked()

builds ProductPagedQueryResponse without checking for non-null required values

Returns:

ProductPagedQueryResponse

of

public static ProductPagedQueryResponseBuilder of()

factory method for an instance of ProductPagedQueryResponseBuilder

Returns:

builder

of

public static ProductPagedQueryResponseBuilder of(ProductPagedQueryResponse template)

create builder for ProductPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder