Interface DisplayFormatOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>, SdkBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>, SdkPojo
Enclosing class:
DisplayFormatOptions
@Mutable @NotThreadSafe public static interface DisplayFormatOptions.Builder extends SdkPojo, CopyableBuilder<DisplayFormatOptions.Builder,DisplayFormatOptions>

  • Method Details

    • useBlankCellFormat

      DisplayFormatOptions.Builder useBlankCellFormat(Boolean useBlankCellFormat)

      A Boolean value that indicates whether to use blank cell format.

      Parameters:
      useBlankCellFormat - A Boolean value that indicates whether to use blank cell format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blankCellFormat

      DisplayFormatOptions.Builder blankCellFormat(String blankCellFormat)

      Determines the blank cell format.

      Parameters:
      blankCellFormat - Determines the blank cell format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dateFormat

      DisplayFormatOptions.Builder dateFormat(String dateFormat)

      Determines the DateTime format.

      Parameters:
      dateFormat - Determines the DateTime format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • decimalSeparator

      DisplayFormatOptions.Builder decimalSeparator(String decimalSeparator)

      Determines the decimal separator.

      Parameters:
      decimalSeparator - Determines the decimal separator.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • decimalSeparator

      DisplayFormatOptions.Builder decimalSeparator(TopicNumericSeparatorSymbol decimalSeparator)

      Determines the decimal separator.

      Parameters:
      decimalSeparator - Determines the decimal separator.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupingSeparator

      DisplayFormatOptions.Builder groupingSeparator(String groupingSeparator)

      Determines the grouping separator.

      Parameters:
      groupingSeparator - Determines the grouping separator.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useGrouping

      DisplayFormatOptions.Builder useGrouping(Boolean useGrouping)

      A Boolean value that indicates whether to use grouping.

      Parameters:
      useGrouping - A Boolean value that indicates whether to use grouping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fractionDigits

      DisplayFormatOptions.Builder fractionDigits(Integer fractionDigits)

      Determines the number of fraction digits.

      Parameters:
      fractionDigits - Determines the number of fraction digits.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • prefix

      DisplayFormatOptions.Builder prefix(String prefix)

      The prefix value for a display format.

      Parameters:
      prefix - The prefix value for a display format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • suffix

      DisplayFormatOptions.Builder suffix(String suffix)

      The suffix value for a display format.

      Parameters:
      suffix - The suffix value for a display format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unitScaler

      DisplayFormatOptions.Builder unitScaler(String unitScaler)

      The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

      Parameters:
      unitScaler - The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unitScaler

      DisplayFormatOptions.Builder unitScaler(NumberScale unitScaler)

      The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

      Parameters:
      unitScaler - The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • negativeFormat

      DisplayFormatOptions.Builder negativeFormat(NegativeFormat negativeFormat)

      The negative format.

      Parameters:
      negativeFormat - The negative format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • negativeFormat

      default DisplayFormatOptions.Builder negativeFormat(Consumer<NegativeFormat.Builder> negativeFormat)

      The negative format.

      This is a convenience method that creates an instance of the NegativeFormat.Builder avoiding the need to create one manually via NegativeFormat.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to negativeFormat(NegativeFormat).

      Parameters:
      negativeFormat - a consumer that will call methods on NegativeFormat.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • currencySymbol

      DisplayFormatOptions.Builder currencySymbol(String currencySymbol)

      The currency symbol, such as USD.

      Parameters:
      currencySymbol - The currency symbol, such as USD.
      Returns:
      Returns a reference to this object so that method calls can be chained together.