Package com.commercetools.api.models.common

Class PagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.common.PagedQueryResponseBuilder

All Implemented Interfaces:

Builder<PagedQueryResponse>

public class PagedQueryResponseBuilder
extends Object
implements Builder<PagedQueryResponse>

PagedQueryResponseBuilder Example to create an instance using the builder pattern

     PagedQueryResponse pagedQueryResponse = PagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
PagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
PagedQueryResponse	build()	builds PagedQueryResponse with checking for non-null required values
PagedQueryResponse	buildUnchecked()	builds PagedQueryResponse without checking for non-null required values
PagedQueryResponseBuilder	count(Long count)	Actual number of results returned.
Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of results requested.
Object	getMeta()	Object containing supplementary information about the results.
Long	getOffset()	Number of elements skipped.
List<BaseResource>	getResults()	The resources matching the query predicate.
Long	getTotal()	Total number of results matching the query.
PagedQueryResponseBuilder	limit(Long limit)	Number of results requested.
PagedQueryResponseBuilder	meta(Object meta)	Object containing supplementary information about the results.
static PagedQueryResponseBuilder	of()	factory method for an instance of PagedQueryResponseBuilder
static PagedQueryResponseBuilder	of(PagedQueryResponse template)	create builder for PagedQueryResponse instance
PagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
PagedQueryResponseBuilder	plusResults(BaseResource... results)	The resources matching the query predicate.
PagedQueryResponseBuilder	results(BaseResource... results)	The resources matching the query predicate.
PagedQueryResponseBuilder	results(List<BaseResource> results)	The resources matching the query predicate.
PagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

PagedQueryResponseBuilder

public PagedQueryResponseBuilder()

Method Details

limit

public PagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public PagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public PagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public PagedQueryResponseBuilder 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 PagedQueryResponseBuilder results(BaseResource... results)

The resources matching the query predicate. Each query endpoint returns resources of its specific type.

Parameters:

results - value to be set

Returns:

Builder

results

public PagedQueryResponseBuilder results(List<BaseResource> results)

The resources matching the query predicate. Each query endpoint returns resources of its specific type.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public PagedQueryResponseBuilder plusResults(BaseResource... results)

The resources matching the query predicate. Each query endpoint returns resources of its specific type.

Parameters:

results - value to be set

Returns:

Builder

meta

public PagedQueryResponseBuilder meta(@Nullable
 Object meta)

Object containing supplementary information about the results.

Parameters:

meta - value to be set

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<BaseResource> getResults()

The resources matching the query predicate. Each query endpoint returns resources of its specific type.

Returns:

results

getMeta

@Nullable
public Object getMeta()

Object containing supplementary information about the results.

Returns:

meta

build

public PagedQueryResponse build()

builds PagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<PagedQueryResponse>

Returns:

PagedQueryResponse

buildUnchecked

public PagedQueryResponse buildUnchecked()

builds PagedQueryResponse without checking for non-null required values

Returns:

PagedQueryResponse

of

public static PagedQueryResponseBuilder of()

factory method for an instance of PagedQueryResponseBuilder

Returns:

builder

of

public static PagedQueryResponseBuilder of(PagedQueryResponse template)

create builder for PagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder