Package com.commercetools.history.models.change_history

Class RecordPagedQueryResponseBuilder

java.lang.Object

com.commercetools.history.models.change_history.RecordPagedQueryResponseBuilder

All Implemented Interfaces:

Builder<RecordPagedQueryResponse>

public class RecordPagedQueryResponseBuilder
extends Object
implements Builder<RecordPagedQueryResponse>

RecordPagedQueryResponseBuilder Example to create an instance using the builder pattern

     RecordPagedQueryResponse recordPagedQueryResponse = RecordPagedQueryResponse.builder()
             .limit(1)
             .count(1)
             .total(1)
             .offset(1)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
RecordPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
RecordPagedQueryResponseBuilder	addResults(Function<RecordBuilder,Record> builder)	Records matching the query.
RecordPagedQueryResponse	build()	builds RecordPagedQueryResponse with checking for non-null required values
RecordPagedQueryResponse	buildUnchecked()	builds RecordPagedQueryResponse without checking for non-null required values
RecordPagedQueryResponseBuilder	count(Integer count)	Actual number of results returned.
Integer	getCount()	Actual number of results returned.
Integer	getLimit()	Number of results requested.
Integer	getOffset()	Number of elements skipped.
List<Record>	getResults()	Records matching the query.
Integer	getTotal()	Total number of results matching the query.
RecordPagedQueryResponseBuilder	limit(Integer limit)	Number of results requested.
static RecordPagedQueryResponseBuilder	of()	factory method for an instance of RecordPagedQueryResponseBuilder
static RecordPagedQueryResponseBuilder	of(RecordPagedQueryResponse template)	create builder for RecordPagedQueryResponse instance
RecordPagedQueryResponseBuilder	offset(Integer offset)	Number of elements skipped.
RecordPagedQueryResponseBuilder	plusResults(Record... results)	Records matching the query.
RecordPagedQueryResponseBuilder	plusResults(Function<RecordBuilder,RecordBuilder> builder)	Records matching the query.
RecordPagedQueryResponseBuilder	results(Record... results)	Records matching the query.
RecordPagedQueryResponseBuilder	results(List<Record> results)	Records matching the query.
RecordPagedQueryResponseBuilder	setResults(Function<RecordBuilder,Record> builder)	Records matching the query.
RecordPagedQueryResponseBuilder	total(Integer total)	Total number of results matching the query.
RecordPagedQueryResponseBuilder	withResults(Function<RecordBuilder,RecordBuilder> builder)	Records matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

RecordPagedQueryResponseBuilder

public RecordPagedQueryResponseBuilder()

Method Details

limit

public RecordPagedQueryResponseBuilder limit(Integer limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

count

public RecordPagedQueryResponseBuilder count(Integer count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public RecordPagedQueryResponseBuilder total(Integer total)

Total number of results matching the query. This number is an estimation and not strongly consistent.

Parameters:

total - value to be set

Returns:

Builder

offset

public RecordPagedQueryResponseBuilder offset(Integer offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

results

public RecordPagedQueryResponseBuilder results(Record... results)

Records matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public RecordPagedQueryResponseBuilder results(List<Record> results)

Records matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public RecordPagedQueryResponseBuilder plusResults(Record... results)

Records matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public RecordPagedQueryResponseBuilder plusResults(Function<RecordBuilder,RecordBuilder> builder)

Records matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public RecordPagedQueryResponseBuilder withResults(Function<RecordBuilder,RecordBuilder> builder)

Records matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public RecordPagedQueryResponseBuilder addResults(Function<RecordBuilder,Record> builder)

Records matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public RecordPagedQueryResponseBuilder setResults(Function<RecordBuilder,Record> builder)

Records matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Integer getLimit()

Number of results requested.

Returns:

limit

getCount

public Integer getCount()

Actual number of results returned.

Returns:

count

getTotal

public Integer getTotal()

Total number of results matching the query. This number is an estimation and not strongly consistent.

Returns:

total

getOffset

public Integer getOffset()

Number of elements skipped.

Returns:

offset

getResults

public List<Record> getResults()

Records matching the query.

Returns:

results

build

public RecordPagedQueryResponse build()

builds RecordPagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<RecordPagedQueryResponse>

Returns:

RecordPagedQueryResponse

buildUnchecked

public RecordPagedQueryResponse buildUnchecked()

builds RecordPagedQueryResponse without checking for non-null required values

Returns:

RecordPagedQueryResponse

of

public static RecordPagedQueryResponseBuilder of()

factory method for an instance of RecordPagedQueryResponseBuilder

Returns:

builder

of

public static RecordPagedQueryResponseBuilder of(RecordPagedQueryResponse template)

create builder for RecordPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder