Package com.commercetools.api.models.product

Class ProductProjectionPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.product.ProductProjectionPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ProductProjectionPagedQueryResponse>

public class ProductProjectionPagedQueryResponseBuilder
extends Object
implements Builder<ProductProjectionPagedQueryResponse>

ProductProjectionPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ProductProjectionPagedQueryResponse productProjectionPagedQueryResponse = ProductProjectionPagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductProjectionPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProductProjectionPagedQueryResponseBuilder

public ProductProjectionPagedQueryResponseBuilder()

Method Details

limit

public ProductProjectionPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

count

public ProductProjectionPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ProductProjectionPagedQueryResponseBuilder 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 ProductProjectionPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

results

public ProductProjectionPagedQueryResponseBuilder results(ProductProjection... results)

ProductProjections matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ProductProjectionPagedQueryResponseBuilder results(List<ProductProjection> results)

ProductProjections matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductProjectionPagedQueryResponseBuilder plusResults(ProductProjection... results)

ProductProjections matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductProjectionPagedQueryResponseBuilder plusResults(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)

ProductProjections matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ProductProjectionPagedQueryResponseBuilder withResults(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)

ProductProjections matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ProductProjectionPagedQueryResponseBuilder addResults(Function<ProductProjectionBuilder,ProductProjection> builder)

ProductProjections matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ProductProjectionPagedQueryResponseBuilder setResults(Function<ProductProjectionBuilder,ProductProjection> builder)

ProductProjections 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<ProductProjection> getResults()

ProductProjections matching the query.

Returns:

results

build

public ProductProjectionPagedQueryResponse build()

builds ProductProjectionPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ProductProjectionPagedQueryResponse>

Returns:

ProductProjectionPagedQueryResponse

buildUnchecked

public ProductProjectionPagedQueryResponse buildUnchecked()

builds ProductProjectionPagedQueryResponse without checking for non-null required values

Returns:

ProductProjectionPagedQueryResponse

of

public static ProductProjectionPagedQueryResponseBuilder of()

factory method for an instance of ProductProjectionPagedQueryResponseBuilder

Returns:

builder

of

public static ProductProjectionPagedQueryResponseBuilder of(ProductProjectionPagedQueryResponse template)

create builder for ProductProjectionPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder