Package com.commercetools.api.models.custom_object

Class CustomObjectPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.custom_object.CustomObjectPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<CustomObjectPagedQueryResponse>

public class CustomObjectPagedQueryResponseBuilder
extends Object
implements Builder<CustomObjectPagedQueryResponse>

CustomObjectPagedQueryResponseBuilder Example to create an instance using the builder pattern

     CustomObjectPagedQueryResponse customObjectPagedQueryResponse = CustomObjectPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomObjectPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CustomObjectPagedQueryResponseBuilder

public CustomObjectPagedQueryResponseBuilder()

Method Details

limit

public CustomObjectPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public CustomObjectPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public CustomObjectPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public CustomObjectPagedQueryResponseBuilder total(@Nullable
 Long total)

The 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 CustomObjectPagedQueryResponseBuilder results(CustomObject... results)

CustomObjects matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public CustomObjectPagedQueryResponseBuilder results(List<CustomObject> results)

CustomObjects matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CustomObjectPagedQueryResponseBuilder plusResults(CustomObject... results)

CustomObjects matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CustomObjectPagedQueryResponseBuilder plusResults(Function<CustomObjectBuilder,CustomObjectBuilder> builder)

CustomObjects matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public CustomObjectPagedQueryResponseBuilder withResults(Function<CustomObjectBuilder,CustomObjectBuilder> builder)

CustomObjects matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public CustomObjectPagedQueryResponseBuilder addResults(Function<CustomObjectBuilder,CustomObject> builder)

CustomObjects matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public CustomObjectPagedQueryResponseBuilder setResults(Function<CustomObjectBuilder,CustomObject> builder)

CustomObjects 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()

The 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<CustomObject> getResults()

CustomObjects matching the query.

Returns:

results

build

public CustomObjectPagedQueryResponse build()

builds CustomObjectPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<CustomObjectPagedQueryResponse>

Returns:

CustomObjectPagedQueryResponse

buildUnchecked

public CustomObjectPagedQueryResponse buildUnchecked()

builds CustomObjectPagedQueryResponse without checking for non-null required values

Returns:

CustomObjectPagedQueryResponse

of

public static CustomObjectPagedQueryResponseBuilder of()

factory method for an instance of CustomObjectPagedQueryResponseBuilder

Returns:

builder

of

public static CustomObjectPagedQueryResponseBuilder of(CustomObjectPagedQueryResponse template)

create builder for CustomObjectPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder