DecimalFormatSymbols (Java 2 Platform SE v1.4.1_"07")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## java.text
Class DecimalFormatSymbols

    java.lang.Object
      |
      +--java.text.DecimalFormatSymbols

All Implemented Interfaces:
  Cloneable, Serializable

public final class DecimalFormatSymbols
extends Object
implements Cloneable, Serializable

This class represents the set of symbols (such as the decimal separator, the grouping separator, and so on) needed by `DecimalFormat` to format numbers. `DecimalFormat` creates for itself an instance of `DecimalFormatSymbols` from its locale data. If you need to change any of these symbols, you can get the `DecimalFormatSymbols` object from your `DecimalFormat` and modify it.

See Also:
  `Locale`, `DecimalFormat`, Serialized Form

Constructor Summary
`DecimalFormatSymbols()` Create a DecimalFormatSymbols object for the default locale.
`DecimalFormatSymbols(Locale locale)` Create a DecimalFormatSymbols object for the given locale.

Method Summary
`Object` | `clone()` Standard override.
`boolean` | `equals(Object obj)` Override equals.
`Currency` | `getCurrency()` Gets the currency of these DecimalFormatSymbols.
`String` | `getCurrencySymbol()` Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.
`char` | `getDecimalSeparator()` Gets the character used for decimal sign.
`char` | `getDigit()` Gets the character used for a digit in a pattern.
`char` | `getGroupingSeparator()` Gets the character used for thousands separator.
`String` | `getInfinity()` Gets the string used to represent infinity.
`String` | `getInternationalCurrencySymbol()` Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.
`char` | `getMinusSign()` Gets the character used to represent minus sign.
`char` | `getMonetaryDecimalSeparator()` Returns the monetary decimal separator.
`String` | `getNaN()` Gets the string used to represent "not a number".
`char` | `getPatternSeparator()` Gets the character used to separate positive and negative subpatterns in a pattern.
`char` | `getPercent()` Gets the character used for percent sign.
`char` | `getPerMill()` Gets the character used for mille percent sign.
`char` | `getZeroDigit()` Gets the character used for zero.
`int` | `hashCode()` Override hashCode.
`void` | `setCurrency(Currency currency)` Sets the currency of these DecimalFormatSymbols.
`void` | `setCurrencySymbol(String currency)` Sets the currency symbol for the currency of these DecimalFormatSymbols in their locale.
`void` | `setDecimalSeparator(char decimalSeparator)` Sets the character used for decimal sign.
`void` | `setDigit(char digit)` Sets the character used for a digit in a pattern.
`void` | `setGroupingSeparator(char groupingSeparator)` Sets the character used for thousands separator.
`void` | `setInfinity(String infinity)` Sets the string used to represent infinity.
`void` | `setInternationalCurrencySymbol(String currencyCode)` Sets the ISO 4217 currency code of the currency of these DecimalFormatSymbols.
`void` | `setMinusSign(char minusSign)` Sets the character used to represent minus sign.
`void` | `setMonetaryDecimalSeparator(char sep)` Sets the monetary decimal separator.
`void` | `setNaN(String NaN)` Sets the string used to represent "not a number".
`void` | `setPatternSeparator(char patternSeparator)` Sets the character used to separate positive and negative subpatterns in a pattern.
`void` | `setPercent(char percent)` Sets the character used for percent sign.
`void` | `setPerMill(char perMill)` Sets the character used for mille percent sign.
`void` | `setZeroDigit(char zeroDigit)` Sets the character used for zero.

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

Constructor Detail

### DecimalFormatSymbols

    public DecimalFormatSymbols()

  Create a DecimalFormatSymbols object for the default locale.

### DecimalFormatSymbols

    public DecimalFormatSymbols(Locale locale)

  Create a DecimalFormatSymbols object for the given locale.

Throws:
  `NullPointerException` - if `locale` is null

Method Detail

### getZeroDigit

    public char getZeroDigit()

  Gets the character used for zero. Different for Arabic, etc.

### setZeroDigit

    public void setZeroDigit(char zeroDigit)

  Sets the character used for zero. Different for Arabic, etc.

### getGroupingSeparator

    public char getGroupingSeparator()

  Gets the character used for thousands separator. Different for French, etc.

### setGroupingSeparator

    public void setGroupingSeparator(char groupingSeparator)

  Sets the character used for thousands separator. Different for French, etc.

### getDecimalSeparator

    public char getDecimalSeparator()

  Gets the character used for decimal sign. Different for French, etc.

### setDecimalSeparator

    public void setDecimalSeparator(char decimalSeparator)

  Sets the character used for decimal sign. Different for French, etc.

### getPerMill

    public char getPerMill()

  Gets the character used for mille percent sign. Different for Arabic, etc.

### setPerMill

    public void setPerMill(char perMill)

  Sets the character used for mille percent sign. Different for Arabic, etc.

### getPercent

    public char getPercent()

  Gets the character used for percent sign. Different for Arabic, etc.

### setPercent

    public void setPercent(char percent)

  Sets the character used for percent sign. Different for Arabic, etc.

### getDigit

    public char getDigit()

  Gets the character used for a digit in a pattern.

### setDigit

    public void setDigit(char digit)

  Sets the character used for a digit in a pattern.

### getPatternSeparator

    public char getPatternSeparator()

  Gets the character used to separate positive and negative subpatterns in a pattern.

### setPatternSeparator

    public void setPatternSeparator(char patternSeparator)

  Sets the character used to separate positive and negative subpatterns in a pattern.

### getInfinity

    public String getInfinity()

  Gets the string used to represent infinity. Almost always left unchanged.

### setInfinity

    public void setInfinity(String infinity)

  Sets the string used to represent infinity. Almost always left unchanged.

### getNaN

    public String getNaN()

  Gets the string used to represent "not a number". Almost always left unchanged.

### setNaN

    public void setNaN(String NaN)

  Sets the string used to represent "not a number". Almost always left unchanged.

### getMinusSign

    public char getMinusSign()

  Gets the character used to represent minus sign. If no explicit negative format is specified, one is formed by prefixing minusSign to the positive format.

### setMinusSign

    public void setMinusSign(char minusSign)

  Sets the character used to represent minus sign. If no explicit negative format is specified, one is formed by prefixing minusSign to the positive format.

### getCurrencySymbol

    public String getCurrencySymbol()

  Returns the currency symbol for the currency of these DecimalFormatSymbols in their locale.

### setCurrencySymbol

    public void setCurrencySymbol(String currency)

  Sets the currency symbol for the currency of these DecimalFormatSymbols in their locale.

### getInternationalCurrencySymbol

    public String getInternationalCurrencySymbol()

  Returns the ISO 4217 currency code of the currency of these DecimalFormatSymbols.

### setInternationalCurrencySymbol

    public void setInternationalCurrencySymbol(String currencyCode)

  Sets the ISO 4217 currency code of the currency of these DecimalFormatSymbols. If the currency code is valid (as defined by `Currency.getInstance`), this also sets the currency attribute to the corresponding Currency instance and the currency symbol attribute to the currency's symbol in the DecimalFormatSymbols' locale. If the currency code is not valid, then the currency attribute is set to null and the currency symbol attribute is not modified.

  See Also:
    `setCurrency(java.util.Currency)`, `setCurrencySymbol(java.lang.String)`

### getCurrency

    public Currency getCurrency()

  Gets the currency of these DecimalFormatSymbols. May be null if the currency symbol attribute was previously set to a value that's not a valid ISO 4217 currency code.

  Returns:
    the currency used, or null
  Since:
    1.4

### setCurrency

    public void setCurrency(Currency currency)

  Sets the currency of these DecimalFormatSymbols. This also sets the currency symbol attribute to the currency's symbol in the DecimalFormatSymbols' locale, and the international currency symbol attribute to the currency's ISO 4217 currency code.

  Parameters:
    `currency` - the new currency to be used
  Throws:
    `NullPointerException` - if `currency` is null
  Since:
    1.4
  See Also:
    `setCurrencySymbol(java.lang.String)`, `setInternationalCurrencySymbol(java.lang.String)`

### getMonetaryDecimalSeparator

    public char getMonetaryDecimalSeparator()

  Returns the monetary decimal separator.

### setMonetaryDecimalSeparator

    public void setMonetaryDecimalSeparator(char sep)

  Sets the monetary decimal separator.

### clone

    public Object clone()

  Standard override.

  Overrides:
    `clone` in class `Object`
  Returns:
    a clone of this instance.
  See Also:
    `Cloneable`

### equals

    public boolean equals(Object obj)

  Override equals.

  Overrides:
    `equals` in class `Object`
  Parameters:
    `obj` - the reference object with which to compare.
  Returns:
    `true` if this object is the same as the obj argument; `false` otherwise.
  See Also:
    `Object.hashCode()`, `Hashtable`

### hashCode

    public int hashCode()

  Override hashCode.

  Overrides:
    `hashCode` in class `Object`
  Returns:
    a hash code value for this object.
  See Also:
    `Object.equals(java.lang.Object)`, `Hashtable`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

JavaTM 2 Platform
Std. Ed. v1.4.1_"07"

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.