Class ReviewPagedQueryResponseBuilder
- All Implemented Interfaces:
Builder<ReviewPagedQueryResponse>
Example to create an instance using the builder pattern
ReviewPagedQueryResponse reviewPagedQueryResponse = ReviewPagedQueryResponse.builder()
.limit(0.3)
.count(0.3)
.offset(0.3)
.plusResults(resultsBuilder -> resultsBuilder)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddResults
(Function<ReviewBuilder, Review> builder) Reviews matching the query.build()
builds ReviewPagedQueryResponse with checking for non-null required valuesbuilds ReviewPagedQueryResponse without checking for non-null required valuesActual number of results returned.getCount()
Actual number of results returned.getLimit()
Number of results requested.Number of elements skipped.Reviews matching the query.getTotal()
Total number of results matching the query.Number of results requested.of()
factory method for an instance of ReviewPagedQueryResponseBuilderof
(ReviewPagedQueryResponse template) create builder for ReviewPagedQueryResponse instanceNumber of elements skipped.plusResults
(Review... results) Reviews matching the query.plusResults
(Function<ReviewBuilder, ReviewBuilder> builder) Reviews matching the query.Reviews matching the query.Reviews matching the query.setResults
(Function<ReviewBuilder, Review> builder) Reviews matching the query.Total number of results matching the query.withResults
(Function<ReviewBuilder, ReviewBuilder> builder) Reviews matching the query.
-
Constructor Details
-
ReviewPagedQueryResponseBuilder
public ReviewPagedQueryResponseBuilder()
-
-
Method Details
-
limit
Number of results requested.
- Parameters:
limit
- value to be set- Returns:
- Builder
-
count
Actual number of results returned.
- Parameters:
count
- value to be set- Returns:
- Builder
-
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
-
offset
Number of elements skipped.
- Parameters:
offset
- value to be set- Returns:
- Builder
-
results
Reviews matching the query.
- Parameters:
results
- value to be set- Returns:
- Builder
-
results
Reviews matching the query.
- Parameters:
results
- value to be set- Returns:
- Builder
-
plusResults
Reviews matching the query.
- Parameters:
results
- value to be set- Returns:
- Builder
-
plusResults
Reviews matching the query.
- Parameters:
builder
- function to build the results value- Returns:
- Builder
-
withResults
Reviews matching the query.
- Parameters:
builder
- function to build the results value- Returns:
- Builder
-
addResults
Reviews matching the query.
- Parameters:
builder
- function to build the results value- Returns:
- Builder
-
setResults
Reviews matching the query.
- Parameters:
builder
- function to build the results value- Returns:
- Builder
-
getLimit
Number of results requested.
- Returns:
- limit
-
getCount
Actual number of results returned.
- Returns:
- count
-
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
-
getOffset
Number of elements skipped.
- Returns:
- offset
-
getResults
Reviews matching the query.
- Returns:
- results
-
build
builds ReviewPagedQueryResponse with checking for non-null required values- Specified by:
build
in interfaceBuilder<ReviewPagedQueryResponse>
- Returns:
- ReviewPagedQueryResponse
-
buildUnchecked
builds ReviewPagedQueryResponse without checking for non-null required values- Returns:
- ReviewPagedQueryResponse
-
of
factory method for an instance of ReviewPagedQueryResponseBuilder- Returns:
- builder
-
of
create builder for ReviewPagedQueryResponse instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-