Package com.commercetools.api.models.variant

Class VariantPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.variant.VariantPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<VariantPagedQueryResponse>

public class VariantPagedQueryResponseBuilder
extends Object
implements Builder<VariantPagedQueryResponse>

VariantPagedQueryResponseBuilder Example to create an instance using the builder pattern

     VariantPagedQueryResponse variantPagedQueryResponse = VariantPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
VariantPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

VariantPagedQueryResponseBuilder

public VariantPagedQueryResponseBuilder()

Method Details

limit

public VariantPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public VariantPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public VariantPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public VariantPagedQueryResponseBuilder 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. Unless absolutely necessary, use the query parameter withTotal=false to improve performance by deactivating the calculation of this field. 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 VariantPagedQueryResponseBuilder results(Variant... results)

Variants matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public VariantPagedQueryResponseBuilder results(List<Variant> results)

Variants matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public VariantPagedQueryResponseBuilder plusResults(Variant... results)

Variants matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public VariantPagedQueryResponseBuilder plusResults(Function<VariantBuilder,VariantBuilder> builder)

Variants matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public VariantPagedQueryResponseBuilder withResults(Function<VariantBuilder,VariantBuilder> builder)

Variants matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public VariantPagedQueryResponseBuilder addResults(Function<VariantBuilder,Variant> builder)

Variants matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public VariantPagedQueryResponseBuilder setResults(Function<VariantBuilder,Variant> builder)

Variants 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. Unless absolutely necessary, use the query parameter withTotal=false to improve performance by deactivating the calculation of this field. When the results are filtered with a Query Predicate, total is subject to a limit.

Returns:

total

getResults

public List<Variant> getResults()

Variants matching the query.

Returns:

results

build

public VariantPagedQueryResponse build()

builds VariantPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<VariantPagedQueryResponse>

Returns:

VariantPagedQueryResponse

buildUnchecked

public VariantPagedQueryResponse buildUnchecked()

builds VariantPagedQueryResponse without checking for non-null required values

Returns:

VariantPagedQueryResponse

of

public static VariantPagedQueryResponseBuilder of()

factory method for an instance of VariantPagedQueryResponseBuilder

Returns:

builder

of

public static VariantPagedQueryResponseBuilder of(VariantPagedQueryResponse template)

create builder for VariantPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder