Package com.commercetools.api.models.state

Class StatePagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.state.StatePagedQueryResponseBuilder

All Implemented Interfaces:

Builder<StatePagedQueryResponse>

public class StatePagedQueryResponseBuilder
extends Object
implements Builder<StatePagedQueryResponse>

StatePagedQueryResponseBuilder Example to create an instance using the builder pattern

     StatePagedQueryResponse statePagedQueryResponse = StatePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
StatePagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

StatePagedQueryResponseBuilder

public StatePagedQueryResponseBuilder()

Method Details

limit

public StatePagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public StatePagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public StatePagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public StatePagedQueryResponseBuilder 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 StatePagedQueryResponseBuilder results(State... results)

States matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public StatePagedQueryResponseBuilder results(List<State> results)

States matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public StatePagedQueryResponseBuilder plusResults(State... results)

States matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public StatePagedQueryResponseBuilder plusResults(Function<StateBuilder,StateBuilder> builder)

States matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public StatePagedQueryResponseBuilder withResults(Function<StateBuilder,StateBuilder> builder)

States matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public StatePagedQueryResponseBuilder addResults(Function<StateBuilder,State> builder)

States matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public StatePagedQueryResponseBuilder setResults(Function<StateBuilder,State> builder)

States 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<State> getResults()

States matching the query.

Returns:

results

build

public StatePagedQueryResponse build()

builds StatePagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<StatePagedQueryResponse>

Returns:

StatePagedQueryResponse

buildUnchecked

public StatePagedQueryResponse buildUnchecked()

builds StatePagedQueryResponse without checking for non-null required values

Returns:

StatePagedQueryResponse

of

public static StatePagedQueryResponseBuilder of()

factory method for an instance of StatePagedQueryResponseBuilder

Returns:

builder

of

public static StatePagedQueryResponseBuilder of(StatePagedQueryResponse template)

create builder for StatePagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder