Package com.commercetools.api.models.product_search

Class ProductPagedSearchResponseBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductPagedSearchResponseBuilder

All Implemented Interfaces:

Builder<ProductPagedSearchResponse>

public class ProductPagedSearchResponseBuilder
extends Object
implements Builder<ProductPagedSearchResponse>

ProductPagedSearchResponseBuilder Example to create an instance using the builder pattern

     ProductPagedSearchResponse productPagedSearchResponse = ProductPagedSearchResponse.builder()
             .total(0.3)
             .offset(0.3)
             .limit(0.3)
             .plusFacets(facetsBuilder -> facetsBuilder)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductPagedSearchResponseBuilder()

Method Summary

Modifier and Type	Method	Description
ProductPagedSearchResponseBuilder	addFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResult> builder)	Results for facets when requested.
ProductPagedSearchResponseBuilder	addResults(Function<ProductSearchResultBuilder,ProductSearchResult> builder)	Search result containing the Products matching the search query.
ProductPagedSearchResponse	build()	builds ProductPagedSearchResponse with checking for non-null required values
ProductPagedSearchResponse	buildUnchecked()	builds ProductPagedSearchResponse without checking for non-null required values
ProductPagedSearchResponseBuilder	facets(ProductSearchFacetResult... facets)	Results for facets when requested.
ProductPagedSearchResponseBuilder	facets(List<ProductSearchFacetResult> facets)	Results for facets when requested.
List<ProductSearchFacetResult>	getFacets()	Results for facets when requested.
Integer	getLimit()	Number of results requested.
Integer	getOffset()	Number of elements skipped.
List<ProductSearchResult>	getResults()	Search result containing the Products matching the search query.
Long	getTotal()	Total number of results matching the query.
ProductPagedSearchResponseBuilder	limit(Integer limit)	Number of results requested.
static ProductPagedSearchResponseBuilder	of()	factory method for an instance of ProductPagedSearchResponseBuilder
static ProductPagedSearchResponseBuilder	of(ProductPagedSearchResponse template)	create builder for ProductPagedSearchResponse instance
ProductPagedSearchResponseBuilder	offset(Integer offset)	Number of elements skipped.
ProductPagedSearchResponseBuilder	plusFacets(ProductSearchFacetResult... facets)	Results for facets when requested.
ProductPagedSearchResponseBuilder	plusFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResultBuilder> builder)	Results for facets when requested.
ProductPagedSearchResponseBuilder	plusResults(ProductSearchResult... results)	Search result containing the Products matching the search query.
ProductPagedSearchResponseBuilder	plusResults(Function<ProductSearchResultBuilder,ProductSearchResultBuilder> builder)	Search result containing the Products matching the search query.
ProductPagedSearchResponseBuilder	results(ProductSearchResult... results)	Search result containing the Products matching the search query.
ProductPagedSearchResponseBuilder	results(List<ProductSearchResult> results)	Search result containing the Products matching the search query.
ProductPagedSearchResponseBuilder	setFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResult> builder)	Results for facets when requested.
ProductPagedSearchResponseBuilder	setResults(Function<ProductSearchResultBuilder,ProductSearchResult> builder)	Search result containing the Products matching the search query.
ProductPagedSearchResponseBuilder	total(Long total)	Total number of results matching the query.
ProductPagedSearchResponseBuilder	withFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResultBuilder> builder)	Results for facets when requested.
ProductPagedSearchResponseBuilder	withResults(Function<ProductSearchResultBuilder,ProductSearchResultBuilder> builder)	Search result containing the Products matching the search query.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductPagedSearchResponseBuilder

public ProductPagedSearchResponseBuilder()

Method Details

total

public ProductPagedSearchResponseBuilder total(Long total)

Total number of results matching the query.

Parameters:

total - value to be set

Returns:

Builder

offset

public ProductPagedSearchResponseBuilder offset(Integer offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

limit

public ProductPagedSearchResponseBuilder limit(Integer limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

facets

public ProductPagedSearchResponseBuilder facets(ProductSearchFacetResult... facets)

Results for facets when requested.

Parameters:

facets - value to be set

Returns:

Builder

facets

public ProductPagedSearchResponseBuilder facets(List<ProductSearchFacetResult> facets)

Results for facets when requested.

Parameters:

facets - value to be set

Returns:

Builder

plusFacets

public ProductPagedSearchResponseBuilder plusFacets(ProductSearchFacetResult... facets)

Results for facets when requested.

Parameters:

facets - value to be set

Returns:

Builder

plusFacets

public ProductPagedSearchResponseBuilder plusFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResultBuilder> builder)

Results for facets when requested.

Parameters:

builder - function to build the facets value

Returns:

Builder

withFacets

public ProductPagedSearchResponseBuilder withFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResultBuilder> builder)

Results for facets when requested.

Parameters:

builder - function to build the facets value

Returns:

Builder

addFacets

public ProductPagedSearchResponseBuilder addFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResult> builder)

Results for facets when requested.

Parameters:

builder - function to build the facets value

Returns:

Builder

setFacets

public ProductPagedSearchResponseBuilder setFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResult> builder)

Results for facets when requested.

Parameters:

builder - function to build the facets value

Returns:

Builder

results

public ProductPagedSearchResponseBuilder results(ProductSearchResult... results)

Search result containing the Products matching the search query.

Parameters:

results - value to be set

Returns:

Builder

results

public ProductPagedSearchResponseBuilder results(List<ProductSearchResult> results)

Search result containing the Products matching the search query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductPagedSearchResponseBuilder plusResults(ProductSearchResult... results)

Search result containing the Products matching the search query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductPagedSearchResponseBuilder plusResults(Function<ProductSearchResultBuilder,ProductSearchResultBuilder> builder)

Search result containing the Products matching the search query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ProductPagedSearchResponseBuilder withResults(Function<ProductSearchResultBuilder,ProductSearchResultBuilder> builder)

Search result containing the Products matching the search query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ProductPagedSearchResponseBuilder addResults(Function<ProductSearchResultBuilder,ProductSearchResult> builder)

Search result containing the Products matching the search query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ProductPagedSearchResponseBuilder setResults(Function<ProductSearchResultBuilder,ProductSearchResult> builder)

Search result containing the Products matching the search query.

Parameters:

builder - function to build the results value

Returns:

Builder

getTotal

public Long getTotal()

Total number of results matching the query.

Returns:

total

getOffset

public Integer getOffset()

Number of elements skipped.

Returns:

offset

getLimit

public Integer getLimit()

Number of results requested.

Returns:

limit

getFacets

public List<ProductSearchFacetResult> getFacets()

Results for facets when requested.

Returns:

facets

getResults

public List<ProductSearchResult> getResults()

Search result containing the Products matching the search query.

Returns:

results

build

public ProductPagedSearchResponse build()

builds ProductPagedSearchResponse with checking for non-null required values

Specified by:

build in interface Builder<ProductPagedSearchResponse>

Returns:

ProductPagedSearchResponse

buildUnchecked

public ProductPagedSearchResponse buildUnchecked()

builds ProductPagedSearchResponse without checking for non-null required values

Returns:

ProductPagedSearchResponse

of

public static ProductPagedSearchResponseBuilder of()

factory method for an instance of ProductPagedSearchResponseBuilder

Returns:

builder

of

public static ProductPagedSearchResponseBuilder of(ProductPagedSearchResponse template)

create builder for ProductPagedSearchResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder