Package com.commercetools.api.models.inventory

Class InventoryPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.inventory.InventoryPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<InventoryPagedQueryResponse>

public class InventoryPagedQueryResponseBuilder
extends Object
implements Builder<InventoryPagedQueryResponse>

InventoryPagedQueryResponseBuilder Example to create an instance using the builder pattern

     InventoryPagedQueryResponse inventoryPagedQueryResponse = InventoryPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
InventoryPagedQueryResponseBuilder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryPagedQueryResponseBuilder

public InventoryPagedQueryResponseBuilder()

Method Details

limit

public InventoryPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public InventoryPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public InventoryPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public InventoryPagedQueryResponseBuilder 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 InventoryPagedQueryResponseBuilder results(InventoryEntry... results)

Inventory entries matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public InventoryPagedQueryResponseBuilder results(List<InventoryEntry> results)

Inventory entries matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public InventoryPagedQueryResponseBuilder plusResults(InventoryEntry... results)

Inventory entries matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public InventoryPagedQueryResponseBuilder plusResults(Function<InventoryEntryBuilder,InventoryEntryBuilder> builder)

Inventory entries matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public InventoryPagedQueryResponseBuilder withResults(Function<InventoryEntryBuilder,InventoryEntryBuilder> builder)

Inventory entries matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public InventoryPagedQueryResponseBuilder addResults(Function<InventoryEntryBuilder,InventoryEntry> builder)

Inventory entries matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public InventoryPagedQueryResponseBuilder setResults(Function<InventoryEntryBuilder,InventoryEntry> builder)

Inventory entries 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<InventoryEntry> getResults()

Inventory entries matching the query.

Returns:

results

build

public InventoryPagedQueryResponse build()

builds InventoryPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<InventoryPagedQueryResponse>

Returns:

InventoryPagedQueryResponse

buildUnchecked

public InventoryPagedQueryResponse buildUnchecked()

builds InventoryPagedQueryResponse without checking for non-null required values

Returns:

InventoryPagedQueryResponse

of

public static InventoryPagedQueryResponseBuilder of()

factory method for an instance of InventoryPagedQueryResponseBuilder

Returns:

builder

of

public static InventoryPagedQueryResponseBuilder of(InventoryPagedQueryResponse template)

create builder for InventoryPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder