Package com.commercetools.api.models.extension

Class ExtensionPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.extension.ExtensionPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ExtensionPagedQueryResponse>

public class ExtensionPagedQueryResponseBuilder
extends Object
implements Builder<ExtensionPagedQueryResponse>

ExtensionPagedQueryResponseBuilder Example to create an instance using the builder pattern

     ExtensionPagedQueryResponse extensionPagedQueryResponse = ExtensionPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ExtensionPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ExtensionPagedQueryResponseBuilder

public ExtensionPagedQueryResponseBuilder()

Method Details

limit

public ExtensionPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ExtensionPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ExtensionPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ExtensionPagedQueryResponseBuilder 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 ExtensionPagedQueryResponseBuilder results(Extension... results)

Extensions matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ExtensionPagedQueryResponseBuilder results(List<Extension> results)

Extensions matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ExtensionPagedQueryResponseBuilder plusResults(Extension... results)

Extensions matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ExtensionPagedQueryResponseBuilder plusResults(Function<ExtensionBuilder,ExtensionBuilder> builder)

Extensions matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ExtensionPagedQueryResponseBuilder withResults(Function<ExtensionBuilder,ExtensionBuilder> builder)

Extensions matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ExtensionPagedQueryResponseBuilder addResults(Function<ExtensionBuilder,Extension> builder)

Extensions matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ExtensionPagedQueryResponseBuilder setResults(Function<ExtensionBuilder,Extension> builder)

Extensions 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<Extension> getResults()

Extensions matching the query.

Returns:

results

build

public ExtensionPagedQueryResponse build()

builds ExtensionPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ExtensionPagedQueryResponse>

Returns:

ExtensionPagedQueryResponse

buildUnchecked

public ExtensionPagedQueryResponse buildUnchecked()

builds ExtensionPagedQueryResponse without checking for non-null required values

Returns:

ExtensionPagedQueryResponse

of

public static ExtensionPagedQueryResponseBuilder of()

factory method for an instance of ExtensionPagedQueryResponseBuilder

Returns:

builder

of

public static ExtensionPagedQueryResponseBuilder of(ExtensionPagedQueryResponse template)

create builder for ExtensionPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder