Package com.commercetools.api.models.type

Class TypePagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.type.TypePagedQueryResponseBuilder

All Implemented Interfaces:

Builder<TypePagedQueryResponse>

public class TypePagedQueryResponseBuilder
extends Object
implements Builder<TypePagedQueryResponse>

TypePagedQueryResponseBuilder Example to create an instance using the builder pattern

     TypePagedQueryResponse typePagedQueryResponse = TypePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
TypePagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

TypePagedQueryResponseBuilder

public TypePagedQueryResponseBuilder()

Method Details

limit

public TypePagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public TypePagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public TypePagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public TypePagedQueryResponseBuilder 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 TypePagedQueryResponseBuilder results(Type... results)

Types matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public TypePagedQueryResponseBuilder results(List<Type> results)

Types matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public TypePagedQueryResponseBuilder plusResults(Type... results)

Types matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public TypePagedQueryResponseBuilder plusResults(Function<TypeBuilder,TypeBuilder> builder)

Types matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public TypePagedQueryResponseBuilder withResults(Function<TypeBuilder,TypeBuilder> builder)

Types matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public TypePagedQueryResponseBuilder addResults(Function<TypeBuilder,Type> builder)

Types matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public TypePagedQueryResponseBuilder setResults(Function<TypeBuilder,Type> builder)

Types 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<Type> getResults()

Types matching the query.

Returns:

results

build

public TypePagedQueryResponse build()

builds TypePagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<TypePagedQueryResponse>

Returns:

TypePagedQueryResponse

buildUnchecked

public TypePagedQueryResponse buildUnchecked()

builds TypePagedQueryResponse without checking for non-null required values

Returns:

TypePagedQueryResponse

of

public static TypePagedQueryResponseBuilder of()

factory method for an instance of TypePagedQueryResponseBuilder

Returns:

builder

of

public static TypePagedQueryResponseBuilder of(TypePagedQueryResponse template)

create builder for TypePagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder