Package com.commercetools.api.models.customer

Class CustomerPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.customer.CustomerPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<CustomerPagedQueryResponse>

public class CustomerPagedQueryResponseBuilder
extends Object
implements Builder<CustomerPagedQueryResponse>

CustomerPagedQueryResponseBuilder Example to create an instance using the builder pattern

     CustomerPagedQueryResponse customerPagedQueryResponse = CustomerPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomerPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CustomerPagedQueryResponseBuilder

public CustomerPagedQueryResponseBuilder()

Method Details

limit

public CustomerPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public CustomerPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public CustomerPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public CustomerPagedQueryResponseBuilder 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 CustomerPagedQueryResponseBuilder results(Customer... results)

Customers matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public CustomerPagedQueryResponseBuilder results(List<Customer> results)

Customers matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CustomerPagedQueryResponseBuilder plusResults(Customer... results)

Customers matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CustomerPagedQueryResponseBuilder plusResults(Function<CustomerBuilder,CustomerBuilder> builder)

Customers matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public CustomerPagedQueryResponseBuilder withResults(Function<CustomerBuilder,CustomerBuilder> builder)

Customers matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public CustomerPagedQueryResponseBuilder addResults(Function<CustomerBuilder,Customer> builder)

Customers matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public CustomerPagedQueryResponseBuilder setResults(Function<CustomerBuilder,Customer> builder)

Customers 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<Customer> getResults()

Customers matching the query.

Returns:

results

build

public CustomerPagedQueryResponse build()

builds CustomerPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<CustomerPagedQueryResponse>

Returns:

CustomerPagedQueryResponse

buildUnchecked

public CustomerPagedQueryResponse buildUnchecked()

builds CustomerPagedQueryResponse without checking for non-null required values

Returns:

CustomerPagedQueryResponse

of

public static CustomerPagedQueryResponseBuilder of()

factory method for an instance of CustomerPagedQueryResponseBuilder

Returns:

builder

of

public static CustomerPagedQueryResponseBuilder of(CustomerPagedQueryResponse template)

create builder for CustomerPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder