Package com.commercetools.api.models.category

Class CategoryPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.category.CategoryPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<CategoryPagedQueryResponse>

public class CategoryPagedQueryResponseBuilder
extends Object
implements Builder<CategoryPagedQueryResponse>

CategoryPagedQueryResponseBuilder Example to create an instance using the builder pattern

     CategoryPagedQueryResponse categoryPagedQueryResponse = CategoryPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CategoryPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CategoryPagedQueryResponseBuilder

public CategoryPagedQueryResponseBuilder()

Method Details

limit

public CategoryPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public CategoryPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public CategoryPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public CategoryPagedQueryResponseBuilder 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 CategoryPagedQueryResponseBuilder results(Category... results)

Category matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public CategoryPagedQueryResponseBuilder results(List<Category> results)

Category matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CategoryPagedQueryResponseBuilder plusResults(Category... results)

Category matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CategoryPagedQueryResponseBuilder plusResults(Function<CategoryBuilder,CategoryBuilder> builder)

Category matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public CategoryPagedQueryResponseBuilder withResults(Function<CategoryBuilder,CategoryBuilder> builder)

Category matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public CategoryPagedQueryResponseBuilder addResults(Function<CategoryBuilder,Category> builder)

Category matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public CategoryPagedQueryResponseBuilder setResults(Function<CategoryBuilder,Category> builder)

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

Category matching the query.

Returns:

results

build

public CategoryPagedQueryResponse build()

builds CategoryPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<CategoryPagedQueryResponse>

Returns:

CategoryPagedQueryResponse

buildUnchecked

public CategoryPagedQueryResponse buildUnchecked()

builds CategoryPagedQueryResponse without checking for non-null required values

Returns:

CategoryPagedQueryResponse

of

public static CategoryPagedQueryResponseBuilder of()

factory method for an instance of CategoryPagedQueryResponseBuilder

Returns:

builder

of

public static CategoryPagedQueryResponseBuilder of(CategoryPagedQueryResponse template)

create builder for CategoryPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder