Package com.commercetools.api.models.store

Class StorePagedQueryResponseBuilder

java.lang.Object
com.commercetools.api.models.store.StorePagedQueryResponseBuilder
All Implemented Interfaces:
Builder<StorePagedQueryResponse>
public class StorePagedQueryResponseBuilder extends Object implements Builder<StorePagedQueryResponse>
StorePagedQueryResponseBuilder
Example to create an instance using the builder pattern 

     StorePagedQueryResponse storePagedQueryResponse = StorePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()

  • Constructor Details

    • StorePagedQueryResponseBuilder

      public StorePagedQueryResponseBuilder()

  • Method Details

    • limit

      public StorePagedQueryResponseBuilder limit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set
      Returns:
      Builder

    • offset

      public StorePagedQueryResponseBuilder offset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set
      Returns:
      Builder

    • count

      public StorePagedQueryResponseBuilder count(Long count)

      Actual number of results returned.

      Parameters:
      count - value to be set
      Returns:
      Builder

    • total

      public StorePagedQueryResponseBuilder 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 StorePagedQueryResponseBuilder results(Store... results)

      Stores matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • results

      public StorePagedQueryResponseBuilder results(List<Store> results)

      Stores matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public StorePagedQueryResponseBuilder plusResults(Store... results)

      Stores matching the query.

      Parameters:
      results - value to be set
      Returns:
      Builder

    • plusResults

      public StorePagedQueryResponseBuilder plusResults(Function<StoreBuilder,StoreBuilder> builder)

      Stores matching the query.

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

    • withResults

      public StorePagedQueryResponseBuilder withResults(Function<StoreBuilder,StoreBuilder> builder)

      Stores matching the query.

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

    • addResults

      public StorePagedQueryResponseBuilder addResults(Function<StoreBuilder,Store> builder)

      Stores matching the query.

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

    • setResults

      public StorePagedQueryResponseBuilder setResults(Function<StoreBuilder,Store> builder)

      Stores 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<Store> getResults()

      Stores matching the query.

      Returns:
      results

    • build

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

    • buildUnchecked

      public StorePagedQueryResponse buildUnchecked()
      builds StorePagedQueryResponse without checking for non-null required values
      Returns:
      StorePagedQueryResponse

    • of

      public static StorePagedQueryResponseBuilder of()
      factory method for an instance of StorePagedQueryResponseBuilder
      Returns:
      builder

    • of

      public static StorePagedQueryResponseBuilder of(StorePagedQueryResponse template)
      create builder for StorePagedQueryResponse instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder