Package com.commercetools.api.models.api_client

Class ApiClientPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.api_client.ApiClientPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ApiClientPagedQueryResponse>

public class ApiClientPagedQueryResponseBuilder
extends Object
implements Builder<ApiClientPagedQueryResponse>

ApiClientPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ApiClientPagedQueryResponse apiClientPagedQueryResponse = ApiClientPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ApiClientPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ApiClientPagedQueryResponseBuilder

public ApiClientPagedQueryResponseBuilder()

Method Details

limit

public ApiClientPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ApiClientPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ApiClientPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ApiClientPagedQueryResponseBuilder 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 ApiClientPagedQueryResponseBuilder results(ApiClient... results)

APIClients matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ApiClientPagedQueryResponseBuilder results(List<ApiClient> results)

APIClients matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ApiClientPagedQueryResponseBuilder plusResults(ApiClient... results)

APIClients matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ApiClientPagedQueryResponseBuilder plusResults(Function<ApiClientBuilder,ApiClientBuilder> builder)

APIClients matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ApiClientPagedQueryResponseBuilder withResults(Function<ApiClientBuilder,ApiClientBuilder> builder)

APIClients matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ApiClientPagedQueryResponseBuilder addResults(Function<ApiClientBuilder,ApiClient> builder)

APIClients matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ApiClientPagedQueryResponseBuilder setResults(Function<ApiClientBuilder,ApiClient> builder)

APIClients 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<ApiClient> getResults()

APIClients matching the query.

Returns:

results

build

public ApiClientPagedQueryResponse build()

builds ApiClientPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ApiClientPagedQueryResponse>

Returns:

ApiClientPagedQueryResponse

buildUnchecked

public ApiClientPagedQueryResponse buildUnchecked()

builds ApiClientPagedQueryResponse without checking for non-null required values

Returns:

ApiClientPagedQueryResponse

of

public static ApiClientPagedQueryResponseBuilder of()

factory method for an instance of ApiClientPagedQueryResponseBuilder

Returns:

builder

of

public static ApiClientPagedQueryResponseBuilder of(ApiClientPagedQueryResponse template)

create builder for ApiClientPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder