Package com.commercetools.api.models.zone

Class ZonePagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.zone.ZonePagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ZonePagedQueryResponse>

public class ZonePagedQueryResponseBuilder
extends Object
implements Builder<ZonePagedQueryResponse>

ZonePagedQueryResponseBuilder Example to create an instance using the builder pattern

     ZonePagedQueryResponse zonePagedQueryResponse = ZonePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ZonePagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ZonePagedQueryResponseBuilder

public ZonePagedQueryResponseBuilder()

Method Details

limit

public ZonePagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ZonePagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ZonePagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ZonePagedQueryResponseBuilder 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 ZonePagedQueryResponseBuilder results(Zone... results)

Zones matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ZonePagedQueryResponseBuilder results(List<Zone> results)

Zones matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ZonePagedQueryResponseBuilder plusResults(Zone... results)

Zones matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ZonePagedQueryResponseBuilder plusResults(Function<ZoneBuilder,ZoneBuilder> builder)

Zones matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ZonePagedQueryResponseBuilder withResults(Function<ZoneBuilder,ZoneBuilder> builder)

Zones matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ZonePagedQueryResponseBuilder addResults(Function<ZoneBuilder,Zone> builder)

Zones matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ZonePagedQueryResponseBuilder setResults(Function<ZoneBuilder,Zone> builder)

Zones 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<Zone> getResults()

Zones matching the query.

Returns:

results

build

public ZonePagedQueryResponse build()

builds ZonePagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ZonePagedQueryResponse>

Returns:

ZonePagedQueryResponse

buildUnchecked

public ZonePagedQueryResponse buildUnchecked()

builds ZonePagedQueryResponse without checking for non-null required values

Returns:

ZonePagedQueryResponse

of

public static ZonePagedQueryResponseBuilder of()

factory method for an instance of ZonePagedQueryResponseBuilder

Returns:

builder

of

public static ZonePagedQueryResponseBuilder of(ZonePagedQueryResponse template)

create builder for ZonePagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder