Package com.commercetools.api.models.attribute_group

Class AttributeGroupPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.attribute_group.AttributeGroupPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<AttributeGroupPagedQueryResponse>

public class AttributeGroupPagedQueryResponseBuilder
extends Object
implements Builder<AttributeGroupPagedQueryResponse>

AttributeGroupPagedQueryResponseBuilder Example to create an instance using the builder pattern

     AttributeGroupPagedQueryResponse attributeGroupPagedQueryResponse = AttributeGroupPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
AttributeGroupPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
AttributeGroupPagedQueryResponseBuilder	addResults(Function<AttributeGroupBuilder,AttributeGroup> builder)	AttributeGroups matching the query.
AttributeGroupPagedQueryResponse	build()	builds AttributeGroupPagedQueryResponse with checking for non-null required values
AttributeGroupPagedQueryResponse	buildUnchecked()	builds AttributeGroupPagedQueryResponse without checking for non-null required values
AttributeGroupPagedQueryResponseBuilder	count(Long count)	Actual number of results returned.
Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of results requested in the query request.
Long	getOffset()	Offset supplied by the client or the server default.
List<AttributeGroup>	getResults()	AttributeGroups matching the query.
Long	getTotal()	Total number of results matching the query.
AttributeGroupPagedQueryResponseBuilder	limit(Long limit)	Number of results requested in the query request.
static AttributeGroupPagedQueryResponseBuilder	of()	factory method for an instance of AttributeGroupPagedQueryResponseBuilder
static AttributeGroupPagedQueryResponseBuilder	of(AttributeGroupPagedQueryResponse template)	create builder for AttributeGroupPagedQueryResponse instance
AttributeGroupPagedQueryResponseBuilder	offset(Long offset)	Offset supplied by the client or the server default.
AttributeGroupPagedQueryResponseBuilder	plusResults(AttributeGroup... results)	AttributeGroups matching the query.
AttributeGroupPagedQueryResponseBuilder	plusResults(Function<AttributeGroupBuilder,AttributeGroupBuilder> builder)	AttributeGroups matching the query.
AttributeGroupPagedQueryResponseBuilder	results(AttributeGroup... results)	AttributeGroups matching the query.
AttributeGroupPagedQueryResponseBuilder	results(List<AttributeGroup> results)	AttributeGroups matching the query.
AttributeGroupPagedQueryResponseBuilder	setResults(Function<AttributeGroupBuilder,AttributeGroup> builder)	AttributeGroups matching the query.
AttributeGroupPagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
AttributeGroupPagedQueryResponseBuilder	withResults(Function<AttributeGroupBuilder,AttributeGroupBuilder> builder)	AttributeGroups matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

AttributeGroupPagedQueryResponseBuilder

public AttributeGroupPagedQueryResponseBuilder()

Method Details

limit

public AttributeGroupPagedQueryResponseBuilder limit(Long limit)

Number of results requested in the query request.

Parameters:

limit - value to be set

Returns:

Builder

offset

public AttributeGroupPagedQueryResponseBuilder offset(Long offset)

Offset supplied by the client or the server default. It is the number of elements skipped, not a page number.

Parameters:

offset - value to be set

Returns:

Builder

count

public AttributeGroupPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public AttributeGroupPagedQueryResponseBuilder 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 AttributeGroupPagedQueryResponseBuilder results(AttributeGroup... results)

AttributeGroups matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public AttributeGroupPagedQueryResponseBuilder results(List<AttributeGroup> results)

AttributeGroups matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public AttributeGroupPagedQueryResponseBuilder plusResults(AttributeGroup... results)

AttributeGroups matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public AttributeGroupPagedQueryResponseBuilder plusResults(Function<AttributeGroupBuilder,AttributeGroupBuilder> builder)

AttributeGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public AttributeGroupPagedQueryResponseBuilder withResults(Function<AttributeGroupBuilder,AttributeGroupBuilder> builder)

AttributeGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public AttributeGroupPagedQueryResponseBuilder addResults(Function<AttributeGroupBuilder,AttributeGroup> builder)

AttributeGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public AttributeGroupPagedQueryResponseBuilder setResults(Function<AttributeGroupBuilder,AttributeGroup> builder)

AttributeGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Long getLimit()

Number of results requested in the query request.

Returns:

limit

getOffset

public Long getOffset()

Offset supplied by the client or the server default. It is the number of elements skipped, not a page number.

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

AttributeGroups matching the query.

Returns:

results

build

public AttributeGroupPagedQueryResponse build()

builds AttributeGroupPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<AttributeGroupPagedQueryResponse>

Returns:

AttributeGroupPagedQueryResponse

buildUnchecked

public AttributeGroupPagedQueryResponse buildUnchecked()

builds AttributeGroupPagedQueryResponse without checking for non-null required values

Returns:

AttributeGroupPagedQueryResponse

of

public static AttributeGroupPagedQueryResponseBuilder of()

factory method for an instance of AttributeGroupPagedQueryResponseBuilder

Returns:

builder

of

public static AttributeGroupPagedQueryResponseBuilder of(AttributeGroupPagedQueryResponse template)

create builder for AttributeGroupPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder