Package com.commercetools.api.models.common

Class HighPrecisionMoneyBuilder

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

     HighPrecisionMoney highPrecisionMoney = HighPrecisionMoney.builder()
             .centAmount(0.3)
             .currencyCode("{currencyCode}")
             .fractionDigits(0.3)
             .preciseAmount(0.3)
             .build()

  • Constructor Details

    • HighPrecisionMoneyBuilder

      public HighPrecisionMoneyBuilder()

  • Method Details

    • centAmount

      public HighPrecisionMoneyBuilder centAmount(Long centAmount)

      Amount in the smallest indivisible unit of a currency, such as:

      • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
      • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
      Parameters:
      centAmount - value to be set
      Returns:
      Builder

    • currencyCode

      public HighPrecisionMoneyBuilder currencyCode(String currencyCode)

      Currency code compliant to ISO 4217.

      Parameters:
      currencyCode - value to be set
      Returns:
      Builder

    • fractionDigits

      public HighPrecisionMoneyBuilder fractionDigits(Integer fractionDigits)

      Number of digits after the decimal separator, greater than the default number of fraction digits for a currency.

      Parameters:
      fractionDigits - value to be set
      Returns:
      Builder

    • preciseAmount

      public HighPrecisionMoneyBuilder preciseAmount(Long preciseAmount)

      Amount in 1 / (10 ^ fractionDigits) of a currency.

      Parameters:
      preciseAmount - value to be set
      Returns:
      Builder

    • getCentAmount

      public Long getCentAmount()

      Amount in the smallest indivisible unit of a currency, such as:

      • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
      • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
      Returns:
      centAmount

    • getCurrencyCode

      public String getCurrencyCode()

      Currency code compliant to ISO 4217.

      Returns:
      currencyCode

    • getFractionDigits

      public Integer getFractionDigits()

      Number of digits after the decimal separator, greater than the default number of fraction digits for a currency.

      Returns:
      fractionDigits

    • getPreciseAmount

      public Long getPreciseAmount()

      Amount in 1 / (10 ^ fractionDigits) of a currency.

      Returns:
      preciseAmount

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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