Class PaymentPagedQueryResponseBuilder

java.lang.Object
com.commercetools.api.models.payment.PaymentPagedQueryResponseBuilder
All Implemented Interfaces:
Builder<PaymentPagedQueryResponse>

public class PaymentPagedQueryResponseBuilder extends Object implements Builder<PaymentPagedQueryResponse>
PaymentPagedQueryResponseBuilder
Example to create an instance using the builder pattern

     PaymentPagedQueryResponse paymentPagedQueryResponse = PaymentPagedQueryResponse.builder()
             .limit(0.3)
             .count(0.3)
             .offset(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 
  • Constructor Details

    • PaymentPagedQueryResponseBuilder

      public PaymentPagedQueryResponseBuilder()
  • Method Details

    • limit

      public PaymentPagedQueryResponseBuilder limit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set
      Returns:
      Builder
    • count

      public PaymentPagedQueryResponseBuilder count(Long 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

      public PaymentPagedQueryResponseBuilder offset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set
      Returns:
      Builder
    • results

      public PaymentPagedQueryResponseBuilder results(Payment... results)

      Payments matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder
    • results

      public PaymentPagedQueryResponseBuilder results(List<Payment> results)

      Payments matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder
    • plusResults

      public PaymentPagedQueryResponseBuilder plusResults(Payment... results)

      Payments matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder
    • plusResults

      Payments matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder
    • withResults

      Payments matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder
    • addResults

      Payments matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder
    • setResults

      Payments matching the query.

      Parameters:
      builder - function to build the results value
      Returns:
      Builder
    • getLimit

      public Long getLimit()

      Number of results requested.

      Returns:
      limit
    • 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
    • getOffset

      public Long getOffset()

      Number of elements skipped.

      Returns:
      offset
    • getResults

      public List<Payment> getResults()

      Payments matching the query.

      Returns:
      results
    • build

      public PaymentPagedQueryResponse build()
      builds PaymentPagedQueryResponse with checking for non-null required values
      Specified by:
      build in interface Builder<PaymentPagedQueryResponse>
      Returns:
      PaymentPagedQueryResponse
    • buildUnchecked

      public PaymentPagedQueryResponse buildUnchecked()
      builds PaymentPagedQueryResponse without checking for non-null required values
      Returns:
      PaymentPagedQueryResponse
    • of

      factory method for an instance of PaymentPagedQueryResponseBuilder
      Returns:
      builder
    • of

      create builder for PaymentPagedQueryResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder