Package com.commercetools.api.models.subscription

Class SubscriptionPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.subscription.SubscriptionPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<SubscriptionPagedQueryResponse>

public class SubscriptionPagedQueryResponseBuilder
extends Object
implements Builder<SubscriptionPagedQueryResponse>

SubscriptionPagedQueryResponseBuilder Example to create an instance using the builder pattern

     SubscriptionPagedQueryResponse subscriptionPagedQueryResponse = SubscriptionPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
SubscriptionPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionPagedQueryResponseBuilder

public SubscriptionPagedQueryResponseBuilder()

Method Details

limit

public SubscriptionPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public SubscriptionPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public SubscriptionPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public SubscriptionPagedQueryResponseBuilder 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 SubscriptionPagedQueryResponseBuilder results(Subscription... results)

Subscriptions matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public SubscriptionPagedQueryResponseBuilder results(List<Subscription> results)

Subscriptions matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public SubscriptionPagedQueryResponseBuilder plusResults(Subscription... results)

Subscriptions matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public SubscriptionPagedQueryResponseBuilder plusResults(Function<SubscriptionBuilder,SubscriptionBuilder> builder)

Subscriptions matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public SubscriptionPagedQueryResponseBuilder withResults(Function<SubscriptionBuilder,SubscriptionBuilder> builder)

Subscriptions matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public SubscriptionPagedQueryResponseBuilder addResults(Function<SubscriptionBuilder,Subscription> builder)

Subscriptions matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public SubscriptionPagedQueryResponseBuilder setResults(Function<SubscriptionBuilder,Subscription> builder)

Subscriptions 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<Subscription> getResults()

Subscriptions matching the query.

Returns:

results

build

public SubscriptionPagedQueryResponse build()

builds SubscriptionPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<SubscriptionPagedQueryResponse>

Returns:

SubscriptionPagedQueryResponse

buildUnchecked

public SubscriptionPagedQueryResponse buildUnchecked()

builds SubscriptionPagedQueryResponse without checking for non-null required values

Returns:

SubscriptionPagedQueryResponse

of

public static SubscriptionPagedQueryResponseBuilder of()

factory method for an instance of SubscriptionPagedQueryResponseBuilder

Returns:

builder

of

public static SubscriptionPagedQueryResponseBuilder of(SubscriptionPagedQueryResponse template)

create builder for SubscriptionPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder