org.threeten.bp.format
Class DecimalStyle

java.lang.Object
  extended by org.threeten.bp.format.DecimalStyle

public final class DecimalStyle
extends Object

Localized symbols used in date and time formatting.

A significant part of dealing with dates and times is the localization. This class acts as a central point for accessing the information.

Specification for implementors

This class is immutable and thread-safe.


Field Summary
static DecimalStyle STANDARD
          The standard set of non-localized symbols.
 
Method Summary
 boolean equals(Object obj)
          Checks if these symbols equal another set of symbols.
static Set<Locale> getAvailableLocales()
          Lists all the locales that are supported.
 char getDecimalSeparator()
          Gets the character that represents the decimal point.
 char getNegativeSign()
          Gets the character that represents the negative sign.
 char getPositiveSign()
          Gets the character that represents the positive sign.
 char getZeroDigit()
          Gets the character that represents zero.
 int hashCode()
          A hash code for these symbols.
static DecimalStyle of(Locale locale)
          Obtains symbols for the specified locale.
static DecimalStyle ofDefaultLocale()
          Obtains symbols for the default locale.
 String toString()
          Returns a string describing these symbols.
 DecimalStyle withDecimalSeparator(char decimalSeparator)
          Returns a copy of the info with a new character that represents the decimal point.
 DecimalStyle withNegativeSign(char negativeSign)
          Returns a copy of the info with a new character that represents the negative sign.
 DecimalStyle withPositiveSign(char positiveSign)
          Returns a copy of the info with a new character that represents the positive sign.
 DecimalStyle withZeroDigit(char zeroDigit)
          Returns a copy of the info with a new character that represents zero.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

STANDARD

public static final DecimalStyle STANDARD
The standard set of non-localized symbols.

This uses standard ASCII characters for zero, positive, negative and a dot for the decimal point.

Method Detail

getAvailableLocales

public static Set<Locale> getAvailableLocales()
Lists all the locales that are supported.

The locale 'en_US' will always be present.

Returns:
an array of locales for which localization is supported

ofDefaultLocale

public static DecimalStyle ofDefaultLocale()
Obtains symbols for the default locale.

This method provides access to locale sensitive symbols.

Returns:
the info, not null

of

public static DecimalStyle of(Locale locale)
Obtains symbols for the specified locale.

This method provides access to locale sensitive symbols.

Parameters:
locale - the locale, not null
Returns:
the info, not null

getZeroDigit

public char getZeroDigit()
Gets the character that represents zero.

The character used to represent digits may vary by culture. This method specifies the zero character to use, which implies the characters for one to nine.

Returns:
the character for zero

withZeroDigit

public DecimalStyle withZeroDigit(char zeroDigit)
Returns a copy of the info with a new character that represents zero.

The character used to represent digits may vary by culture. This method specifies the zero character to use, which implies the characters for one to nine.

Parameters:
zeroDigit - the character for zero
Returns:
a copy with a new character that represents zero, not null

getPositiveSign

public char getPositiveSign()
Gets the character that represents the positive sign.

The character used to represent a positive number may vary by culture. This method specifies the character to use.

Returns:
the character for the positive sign

withPositiveSign

public DecimalStyle withPositiveSign(char positiveSign)
Returns a copy of the info with a new character that represents the positive sign.

The character used to represent a positive number may vary by culture. This method specifies the character to use.

Parameters:
positiveSign - the character for the positive sign
Returns:
a copy with a new character that represents the positive sign, not null

getNegativeSign

public char getNegativeSign()
Gets the character that represents the negative sign.

The character used to represent a negative number may vary by culture. This method specifies the character to use.

Returns:
the character for the negative sign

withNegativeSign

public DecimalStyle withNegativeSign(char negativeSign)
Returns a copy of the info with a new character that represents the negative sign.

The character used to represent a negative number may vary by culture. This method specifies the character to use.

Parameters:
negativeSign - the character for the negative sign
Returns:
a copy with a new character that represents the negative sign, not null

getDecimalSeparator

public char getDecimalSeparator()
Gets the character that represents the decimal point.

The character used to represent a decimal point may vary by culture. This method specifies the character to use.

Returns:
the character for the decimal point

withDecimalSeparator

public DecimalStyle withDecimalSeparator(char decimalSeparator)
Returns a copy of the info with a new character that represents the decimal point.

The character used to represent a decimal point may vary by culture. This method specifies the character to use.

Parameters:
decimalSeparator - the character for the decimal point
Returns:
a copy with a new character that represents the decimal point, not null

equals

public boolean equals(Object obj)
Checks if these symbols equal another set of symbols.

Overrides:
equals in class Object
Parameters:
obj - the object to check, null returns false
Returns:
true if this is equal to the other date

hashCode

public int hashCode()
A hash code for these symbols.

Overrides:
hashCode in class Object
Returns:
a suitable hash code

toString

public String toString()
Returns a string describing these symbols.

Overrides:
toString in class Object
Returns:
a string description, not null


Copyright © 2007–2016 ThreeTen.org. All rights reserved.