DisplayFormatOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.DisplayFormatOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DisplayFormatOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure that represents additional options for display formatting.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DisplayFormatOptions()

Constructors
Constructor and Description
`DisplayFormatOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DisplayFormatOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBlankCellFormat()` Determines the blank cell format.
`String`	`getCurrencySymbol()` The currency symbol, such as `USD`.
`String`	`getDateFormat()` Determines the `DateTime` format.
`String`	`getDecimalSeparator()` Determines the decimal separator.
`Integer`	`getFractionDigits()` Determines the number of fraction digits.
`String`	`getGroupingSeparator()` Determines the grouping separator.
`NegativeFormat`	`getNegativeFormat()` The negative format.
`String`	`getPrefix()` The prefix value for a display format.
`String`	`getSuffix()` The suffix value for a display format.
`String`	`getUnitScaler()` The unit scaler.
`Boolean`	`getUseBlankCellFormat()` A Boolean value that indicates whether to use blank cell format.
`Boolean`	`getUseGrouping()` A Boolean value that indicates whether to use grouping.
`int`	`hashCode()`
`Boolean`	`isUseBlankCellFormat()` A Boolean value that indicates whether to use blank cell format.
`Boolean`	`isUseGrouping()` A Boolean value that indicates whether to use grouping.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBlankCellFormat(String blankCellFormat)` Determines the blank cell format.
`void`	`setCurrencySymbol(String currencySymbol)` The currency symbol, such as `USD`.
`void`	`setDateFormat(String dateFormat)` Determines the `DateTime` format.
`void`	`setDecimalSeparator(String decimalSeparator)` Determines the decimal separator.
`void`	`setFractionDigits(Integer fractionDigits)` Determines the number of fraction digits.
`void`	`setGroupingSeparator(String groupingSeparator)` Determines the grouping separator.
`void`	`setNegativeFormat(NegativeFormat negativeFormat)` The negative format.
`void`	`setPrefix(String prefix)` The prefix value for a display format.
`void`	`setSuffix(String suffix)` The suffix value for a display format.
`void`	`setUnitScaler(String unitScaler)` The unit scaler.
`void`	`setUseBlankCellFormat(Boolean useBlankCellFormat)` A Boolean value that indicates whether to use blank cell format.
`void`	`setUseGrouping(Boolean useGrouping)` A Boolean value that indicates whether to use grouping.
`String`	`toString()` Returns a string representation of this object.
`DisplayFormatOptions`	`withBlankCellFormat(String blankCellFormat)` Determines the blank cell format.
`DisplayFormatOptions`	`withCurrencySymbol(String currencySymbol)` The currency symbol, such as `USD`.
`DisplayFormatOptions`	`withDateFormat(String dateFormat)` Determines the `DateTime` format.
`DisplayFormatOptions`	`withDecimalSeparator(String decimalSeparator)` Determines the decimal separator.
`DisplayFormatOptions`	`withDecimalSeparator(TopicNumericSeparatorSymbol decimalSeparator)` Determines the decimal separator.
`DisplayFormatOptions`	`withFractionDigits(Integer fractionDigits)` Determines the number of fraction digits.
`DisplayFormatOptions`	`withGroupingSeparator(String groupingSeparator)` Determines the grouping separator.
`DisplayFormatOptions`	`withNegativeFormat(NegativeFormat negativeFormat)` The negative format.
`DisplayFormatOptions`	`withPrefix(String prefix)` The prefix value for a display format.
`DisplayFormatOptions`	`withSuffix(String suffix)` The suffix value for a display format.
`DisplayFormatOptions`	`withUnitScaler(NumberScale unitScaler)` The unit scaler.
`DisplayFormatOptions`	`withUnitScaler(String unitScaler)` The unit scaler.
`DisplayFormatOptions`	`withUseBlankCellFormat(Boolean useBlankCellFormat)` A Boolean value that indicates whether to use blank cell format.
`DisplayFormatOptions`	`withUseGrouping(Boolean useGrouping)` A Boolean value that indicates whether to use grouping.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DisplayFormatOptions
```
public DisplayFormatOptions()
```
- Method Detail
  - setUseBlankCellFormat
```
public void setUseBlankCellFormat(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.
  - getUseBlankCellFormat
```
public Boolean getUseBlankCellFormat()
```
    A Boolean value that indicates whether to use blank cell format.
    
    Returns:
    
    A Boolean value that indicates whether to use blank cell format.
  - withUseBlankCellFormat
```
public DisplayFormatOptions withUseBlankCellFormat(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.
  - isUseBlankCellFormat
```
public Boolean isUseBlankCellFormat()
```
    A Boolean value that indicates whether to use blank cell format.
    
    Returns:
    
    A Boolean value that indicates whether to use blank cell format.
  - setBlankCellFormat
```
public void setBlankCellFormat(String blankCellFormat)
```
    Determines the blank cell format.
    
    Parameters:
    
    blankCellFormat - Determines the blank cell format.
  - getBlankCellFormat
```
public String getBlankCellFormat()
```
    Determines the blank cell format.
    
    Returns:
    
    Determines the blank cell format.
  - withBlankCellFormat
```
public DisplayFormatOptions withBlankCellFormat(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.
  - setDateFormat
```
public void setDateFormat(String dateFormat)
```
    Determines the DateTime format.
    
    Parameters:
    
    dateFormat - Determines the DateTime format.
  - getDateFormat
```
public String getDateFormat()
```
    Determines the DateTime format.
    
    Returns:
    
    Determines the DateTime format.
  - withDateFormat
```
public DisplayFormatOptions withDateFormat(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.
  - setDecimalSeparator
```
public void setDecimalSeparator(String decimalSeparator)
```
    Determines the decimal separator.
    
    Parameters:
    
    decimalSeparator - Determines the decimal separator.
    
    See Also:
    
    TopicNumericSeparatorSymbol
  - getDecimalSeparator
```
public String getDecimalSeparator()
```
    Determines the decimal separator.
    
    Returns:
    
    Determines the decimal separator.
    
    See Also:
    
    TopicNumericSeparatorSymbol
  - withDecimalSeparator
```
public DisplayFormatOptions withDecimalSeparator(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:
    
    TopicNumericSeparatorSymbol
  - withDecimalSeparator
```
public DisplayFormatOptions withDecimalSeparator(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:
    
    TopicNumericSeparatorSymbol
  - setGroupingSeparator
```
public void setGroupingSeparator(String groupingSeparator)
```
    Determines the grouping separator.
    
    Parameters:
    
    groupingSeparator - Determines the grouping separator.
  - getGroupingSeparator
```
public String getGroupingSeparator()
```
    Determines the grouping separator.
    
    Returns:
    
    Determines the grouping separator.
  - withGroupingSeparator
```
public DisplayFormatOptions withGroupingSeparator(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.
  - setUseGrouping
```
public void setUseGrouping(Boolean useGrouping)
```
    A Boolean value that indicates whether to use grouping.
    
    Parameters:
    
    useGrouping - A Boolean value that indicates whether to use grouping.
  - getUseGrouping
```
public Boolean getUseGrouping()
```
    A Boolean value that indicates whether to use grouping.
    
    Returns:
    
    A Boolean value that indicates whether to use grouping.
  - withUseGrouping
```
public DisplayFormatOptions withUseGrouping(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.
  - isUseGrouping
```
public Boolean isUseGrouping()
```
    A Boolean value that indicates whether to use grouping.
    
    Returns:
    
    A Boolean value that indicates whether to use grouping.
  - setFractionDigits
```
public void setFractionDigits(Integer fractionDigits)
```
    Determines the number of fraction digits.
    
    Parameters:
    
    fractionDigits - Determines the number of fraction digits.
  - getFractionDigits
```
public Integer getFractionDigits()
```
    Determines the number of fraction digits.
    
    Returns:
    
    Determines the number of fraction digits.
  - withFractionDigits
```
public DisplayFormatOptions withFractionDigits(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.
  - setPrefix
```
public void setPrefix(String prefix)
```
    The prefix value for a display format.
    
    Parameters:
    
    prefix - The prefix value for a display format.
  - getPrefix
```
public String getPrefix()
```
    The prefix value for a display format.
    
    Returns:
    
    The prefix value for a display format.
  - withPrefix
```
public DisplayFormatOptions withPrefix(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.
  - setSuffix
```
public void setSuffix(String suffix)
```
    The suffix value for a display format.
    
    Parameters:
    
    suffix - The suffix value for a display format.
  - getSuffix
```
public String getSuffix()
```
    The suffix value for a display format.
    
    Returns:
    
    The suffix value for a display format.
  - withSuffix
```
public DisplayFormatOptions withSuffix(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.
  - setUnitScaler
```
public void setUnitScaler(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.
    
    See Also:
    
    NumberScale
  - getUnitScaler
```
public String getUnitScaler()
```
    The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
    
    Returns:
    
    The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
    
    See Also:
    
    NumberScale
  - withUnitScaler
```
public DisplayFormatOptions withUnitScaler(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:
    
    NumberScale
  - withUnitScaler
```
public DisplayFormatOptions withUnitScaler(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:
    
    NumberScale
  - setNegativeFormat
```
public void setNegativeFormat(NegativeFormat negativeFormat)
```
    The negative format.
    
    Parameters:
    
    negativeFormat - The negative format.
  - getNegativeFormat
```
public NegativeFormat getNegativeFormat()
```
    The negative format.
    
    Returns:
    
    The negative format.
  - withNegativeFormat
```
public DisplayFormatOptions withNegativeFormat(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.
  - setCurrencySymbol
```
public void setCurrencySymbol(String currencySymbol)
```
    The currency symbol, such as USD.
    
    Parameters:
    
    currencySymbol - The currency symbol, such as USD.
  - getCurrencySymbol
```
public String getCurrencySymbol()
```
    The currency symbol, such as USD.
    
    Returns:
    
    The currency symbol, such as USD.
  - withCurrencySymbol
```
public DisplayFormatOptions withCurrencySymbol(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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DisplayFormatOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DisplayFormatOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DisplayFormatOptions

Method Detail

setUseBlankCellFormat

getUseBlankCellFormat

withUseBlankCellFormat

isUseBlankCellFormat

setBlankCellFormat

getBlankCellFormat

withBlankCellFormat

setDateFormat

getDateFormat

withDateFormat

setDecimalSeparator

getDecimalSeparator

withDecimalSeparator

withDecimalSeparator

setGroupingSeparator

getGroupingSeparator

withGroupingSeparator

setUseGrouping

getUseGrouping

withUseGrouping

isUseGrouping

setFractionDigits

getFractionDigits

withFractionDigits

setPrefix

getPrefix

withPrefix

setSuffix

getSuffix

withSuffix

setUnitScaler

getUnitScaler

withUnitScaler

withUnitScaler

setNegativeFormat

getNegativeFormat

withNegativeFormat

setCurrencySymbol

getCurrencySymbol

withCurrencySymbol

toString

equals

hashCode

clone

marshall