Package com.commercetools.api.models.product

Class FacetRangeBuilder

java.lang.Object
com.commercetools.api.models.product.FacetRangeBuilder
All Implemented Interfaces:
Builder<FacetRange>
Direct Known Subclasses:
FacetResultRangeBuilder
public class FacetRangeBuilder extends Object implements Builder<FacetRange>
FacetRangeBuilder
Example to create an instance using the builder pattern 

     FacetRange facetRange = FacetRange.builder()
             .from(0.3)
             .fromStr("{fromStr}")
             .to(0.3)
             .toStr("{toStr}")
             .count(0.3)
             .total(0.3)
             .min(0.3)
             .max(0.3)
             .mean(0.3)
             .build()

  • Constructor Details

    • FacetRangeBuilder

      public FacetRangeBuilder()

  • Method Details

    • from

      public FacetRangeBuilder from(Double from)

      The range's lower endpoint.

      0 represents -∞.

      Parameters:
      from - value to be set
      Returns:
      Builder

    • fromStr

      public FacetRangeBuilder fromStr(String fromStr)

      The range's lower endpoint.

      An empty string represents -∞.

      Parameters:
      fromStr - value to be set
      Returns:
      Builder

    • to

      public FacetRangeBuilder to(Double to)

      The range's upper endpoint.

      0 represents +∞.

      Parameters:
      to - value to be set
      Returns:
      Builder

    • toStr

      public FacetRangeBuilder toStr(String toStr)

      The range's upper endpoint.

      An empty string represents +∞.

      Parameters:
      toStr - value to be set
      Returns:
      Builder

    • count

      public FacetRangeBuilder count(Long count)

      Number of ProductVariants for which the values in a field fall into the specified range.

      Parameters:
      count - value to be set
      Returns:
      Builder

    • productCount

      public FacetRangeBuilder productCount(@Nullable Long productCount)

      Number of Products for which the values in a field fall into the specified range.

      Present only if the counting products extension is enabled.

      Parameters:
      productCount - value to be set
      Returns:
      Builder

    • total

      public FacetRangeBuilder total(Double total)

      Sum of all values contained in the range.

      Parameters:
      total - value to be set
      Returns:
      Builder

    • min

      public FacetRangeBuilder min(Double min)

      Minimum value within the range.

      Parameters:
      min - value to be set
      Returns:
      Builder

    • max

      public FacetRangeBuilder max(Double max)

      Maximum value within the range.

      Parameters:
      max - value to be set
      Returns:
      Builder

    • mean

      public FacetRangeBuilder mean(Double mean)

      Arithmetic mean of the values within the range.

      Parameters:
      mean - value to be set
      Returns:
      Builder

    • getFrom

      public Double getFrom()

      The range's lower endpoint.

      0 represents -∞.

      Returns:
      from

    • getFromStr

      public String getFromStr()

      The range's lower endpoint.

      An empty string represents -∞.

      Returns:
      fromStr

    • getTo

      public Double getTo()

      The range's upper endpoint.

      0 represents +∞.

      Returns:
      to

    • getToStr

      public String getToStr()

      The range's upper endpoint.

      An empty string represents +∞.

      Returns:
      toStr

    • getCount

      public Long getCount()

      Number of ProductVariants for which the values in a field fall into the specified range.

      Returns:
      count

    • getProductCount

      @Nullable public Long getProductCount()

      Number of Products for which the values in a field fall into the specified range.

      Present only if the counting products extension is enabled.

      Returns:
      productCount

    • getTotal

      public Double getTotal()

      Sum of all values contained in the range.

      Returns:
      total

    • getMin

      public Double getMin()

      Minimum value within the range.

      Returns:
      min

    • getMax

      public Double getMax()

      Maximum value within the range.

      Returns:
      max

    • getMean

      public Double getMean()

      Arithmetic mean of the values within the range.

      Returns:
      mean

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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