OraNumberFormat (Oracle Database Globalization Development Kit Java API Reference)

java.lang.Object
- java.text.Format
- - oracle.i18n.text.OraNumberFormat

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

OraDecimalFormat
```
public abstract class OraNumberFormat
extends Format
```
The OraNumberFormat class is an abstract class to do locale-sensitive formatting and parsing between number and string. It supports Oracle number formatting behavior.

See Also:

OraDecimalFormat, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.text.Format
  Format.Field

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_FIELD` Constant for `ALL_FIELD` alignment.
`static int`	`FRACTION_FIELD` Constant for `FRACTION_FIELD` alignment.
`static int`	`INTEGER_FIELD` Constant for `INTEGER_FIELD` alignment.
`protected boolean`	`SQLImplicit`

Constructor Summary

Constructors
Constructor and Description

OraNumberFormat()

Constructors
Constructor and Description
`OraNumberFormat()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`clone()` Overrides the `clone` method.
`boolean`	`equals(Object obj)` Overrides the `equals` method.
`String`	`format(BigDecimal number)` Formats a `BigDecimal` object into a string.
`abstract StringBuffer`	`format(BigDecimal number, StringBuffer toAppendTo, FieldPosition position)` Formats a `BigDecimal` object into a string.
`String`	`format(BigInteger number)` Formats a `BigInteger` object into a string.
`abstract StringBuffer`	`format(BigInteger number, StringBuffer toAppendTo, FieldPosition position)` Formats a `BigInteger` object into a string.
`String`	`format(double number)` Formats a double number into a string.
`abstract StringBuffer`	`format(double number, StringBuffer toAppendTo, FieldPosition position)` Formats a double number into a string.
`String`	`format(long number)` Formats a long number into a string.
`abstract StringBuffer`	`format(long number, StringBuffer toAppendTo, FieldPosition position)` Formats a long number into a string.
`StringBuffer`	`format(Object number, StringBuffer toAppendTo, FieldPosition position)` Formats an object into a string.
`static OraNumberFormat`	`getCurrencyInstance()` Deprecated. As of Oracle Database 10g Release 2 (10.2), replaced by `OraNumberFormat.getCurrencyInstance(Locale)`
`static OraNumberFormat`	`getCurrencyInstance(Locale locale)` Returns a number formatter that uses the default currency format pattern for the given locale.
`static OraNumberFormat`	`getCurrencyInstance(OraLocaleInfo localeInfo)` Returns a number formatter that uses the default currency format pattern for the given `OraLocaleInfo` object.
`static String`	`getDefaultCurrencyFormatPattern(Locale locale)` Returns the default currency format pattern for the given locale.
`static String`	`getDefaultCurrencyFormatPattern(OraLocaleInfo localeInfo)` Returns the default currency format pattern for the given `OraLocaleInfo` object.
`static String`	`getDefaultNumberFormatPattern(Locale locale)` Returns the default number format pattern for the given locale.
`static String`	`getDefaultNumberFormatPattern(OraLocaleInfo localeInfo)` Returns the default number format pattern for the given `OraLocaleInfo` object.
`static OraNumberFormat`	`getInstance()` Deprecated. As of Oracle Database 10g Release 2 (10.2), replaced by `OraNumberFormat.getInstance(Locale)`
`static OraNumberFormat`	`getInstance(Locale locale)` Returns a number formatter that uses the default currency format pattern for the given locale.
`static OraNumberFormat`	`getInstance(OraLocaleInfo localeInfo)` Returns a number formatter that uses the default currency format pattern for the given `OraLocaleInfo` object.
`protected int`	`getMaximumFractionDigits()`
`protected int`	`getMinimumFractionDigits()`
`protected int`	`getMinimumIntegerDigits()`
`static OraNumberFormat`	`getNumberInstance()` Deprecated. As of Oracle Database 10g Release 2 (10.2), replaced by `OraNumberFormat.getNumberInstance(Locale)`
`static OraNumberFormat`	`getNumberInstance(Locale locale)` Returns a number formatter that uses the default number format pattern for the given locale.
`static OraNumberFormat`	`getNumberInstance(OraLocaleInfo localeInfo)` Returns a number formatter that uses the default number format pattern for the given `OraLocaleInfo` object.
`static OraNumberFormat`	`getSQLImplicitInstance(Locale locale)` Returns a number formatter that uses the default number format pattern for the given locale and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
`static OraNumberFormat`	`getSQLImplicitInstance(OraLocaleInfo localeInfo)` Returns a number formatter that uses the default number format pattern for the given `OraLocaleInfo` object and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
`boolean`	`isGroupingUsed()` Checks if the grouping separator is used for this formatter.
`boolean`	`isParseIntegerOnly()` Checks if this formatter parses integer portion only.
`Number`	`parse(String text)` Parses a string into a number.
`abstract Number`	`parse(String text, ParsePosition parsePosition)` Parses a string into a number, starting from the given parse position.
`Object`	`parseObject(String text, ParsePosition parsePosition)` Parses a string into a (`Number`) object, starting from the given parse position.
`void`	`setGroupingUsed(boolean val)` Sets the switch for grouping separator to the given boolean value.
`protected void`	`setMaximumFractionDigits(int max)`
`protected void`	`setMaximumIntegerDigits(int max)`
`protected void`	`setMinimumFractionDigits(int min)`
`protected void`	`setMinimumIntegerDigits(int min)`
`void`	`setParseIntegerOnly(boolean val)` Sets the switch for parsing integer only to the given boolean value.

Methods inherited from class java.text.Format
format, formatToCharacterIterator, parseObject

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

- Field Detail
  - ALL_FIELD
```
public static final int ALL_FIELD
```
    Constant for ALL_FIELD alignment. Used to specify the field position for formatting. The ALL_FIELD constant is used to indicate all fields specified in a format pattern.
    
    See Also:
    
    Constant Field Values
  - INTEGER_FIELD
```
public static final int INTEGER_FIELD
```
    Constant for INTEGER_FIELD alignment. Used to specify the field position for formatting.
    
    See Also:
    
    Constant Field Values
  - FRACTION_FIELD
```
public static final int FRACTION_FIELD
```
    Constant for FRACTION_FIELD alignment. Used to specify the field position for formatting.
    
    See Also:
    
    Constant Field Values
  - SQLImplicit
```
protected boolean SQLImplicit
```
- Constructor Detail
  - OraNumberFormat
```
public OraNumberFormat()
```
- Method Detail
  - getCurrencyInstance
```
public static OraNumberFormat getCurrencyInstance()
```
    Deprecated. As of Oracle Database 10g Release 2 (10.2), replaced by OraNumberFormat.getCurrencyInstance(Locale)
    
    Returns a number formatter that uses the default currency format pattern for the default locale.
    
    Returns:
    
    a number formatter
  - getCurrencyInstance
```
public static OraNumberFormat getCurrencyInstance(Locale locale)
```
    Returns a number formatter that uses the default currency format pattern for the given locale.
    
    Parameters:
    
    locale - the given locale
    
    Returns:
    
    a number formatter
  - getCurrencyInstance
```
public static OraNumberFormat getCurrencyInstance(OraLocaleInfo localeInfo)
```
    Returns a number formatter that uses the default currency format pattern for the given OraLocaleInfo object.
    
    Parameters:
    
    localeInfo - the given OraLocaleInfo object
    
    Returns:
    
    a number formatter
  - getDefaultCurrencyFormatPattern
```
public static String getDefaultCurrencyFormatPattern(Locale locale)
```
    Returns the default currency format pattern for the given locale.
    
    Parameters:
    
    locale - the given locale
    
    Returns:
    
    the default currency format pattern. The format pattern is in the form of "<positive pattern>;<negative pattern>" or, if patterns for both positive and negative patterns are the same, the form is "<positive pattern>".
  - getDefaultCurrencyFormatPattern
```
public static String getDefaultCurrencyFormatPattern(OraLocaleInfo localeInfo)
```
    Returns the default currency format pattern for the given OraLocaleInfo object.
    
    Parameters:
    
    localeInfo - the given OraLocaleInfo object
    
    Returns:
    
    the default currency format pattern. The format pattern is in the form of "<positive pattern>;<negative pattern>" or, if patterns for both positive and negative patterns are the same, the form is "<positive pattern>".
  - getDefaultNumberFormatPattern
```
public static String getDefaultNumberFormatPattern(Locale locale)
```
    Returns the default number format pattern for the given locale.
    
    Parameters:
    
    locale - the given locale
    
    Returns:
    
    the default number format pattern. The format pattern is in the form of "<positive pattern>;<negative pattern>" or, if patterns for both positive and negative patterns are the same, the form is "<positive pattern>".
  - getDefaultNumberFormatPattern
```
public static String getDefaultNumberFormatPattern(OraLocaleInfo localeInfo)
```
    Returns the default number format pattern for the given OraLocaleInfo object.
    
    Parameters:
    
    localeInfo - the given OraLocaleInfo object
    
    Returns:
    
    the default number format pattern. The format pattern is in the form of "<positive pattern>;<negative pattern>" or, if patterns for both positive and negative patterns are the same, the form is "<positive pattern>".
  - getInstance
```
public static OraNumberFormat getInstance()
```
    Deprecated. As of Oracle Database 10g Release 2 (10.2), replaced by OraNumberFormat.getInstance(Locale)
    
    Returns a number formatter that uses the default number format pattern for the default locale.
    
    Returns:
    
    a number formatter
  - getInstance
```
public static OraNumberFormat getInstance(Locale locale)
```
    Returns a number formatter that uses the default currency format pattern for the given locale.
    
    Parameters:
    
    locale - the given locale
    
    Returns:
    
    a number formatter
  - getInstance
```
public static OraNumberFormat getInstance(OraLocaleInfo localeInfo)
```
    Returns a number formatter that uses the default currency format pattern for the given OraLocaleInfo object.
    
    Parameters:
    
    localeInfo - the given OraLocaleInfo object
    
    Returns:
    
    a number formatter
  - getNumberInstance
```
public static OraNumberFormat getNumberInstance()
```
    Deprecated. As of Oracle Database 10g Release 2 (10.2), replaced by OraNumberFormat.getNumberInstance(Locale)
    
    Returns a number formatter that uses the default number format pattern for the default locale.
    
    Returns:
    
    a number formatter
  - getNumberInstance
```
public static OraNumberFormat getNumberInstance(Locale locale)
```
    Returns a number formatter that uses the default number format pattern for the given locale.
    
    Parameters:
    
    locale - the given locale
    
    Returns:
    
    a number formatter
  - getNumberInstance
```
public static OraNumberFormat getNumberInstance(OraLocaleInfo localeInfo)
```
    Returns a number formatter that uses the default number format pattern for the given OraLocaleInfo object.
    
    Parameters:
    
    localeInfo - the given OraLocaleInfo object
    
    Returns:
    
    a number formatter
  - getSQLImplicitInstance
```
public static OraNumberFormat getSQLImplicitInstance(Locale locale)
```
    Returns a number formatter that uses the default number format pattern for the given locale and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
    
    Parameters:
    
    locale - the given locale
    
    Returns:
    
    a number formatter
  - getSQLImplicitInstance
```
public static OraNumberFormat getSQLImplicitInstance(OraLocaleInfo localeInfo)
```
    Returns a number formatter that uses the default number format pattern for the given OraLocaleInfo object and supports SQL TO_CHAR()/TO_NUMBER() implicit conversion.
    
    Parameters:
    
    localeInfo - the given OraLocaleInfo object
    
    Returns:
    
    a number formatter
  - format
```
public String format(BigDecimal number)
```
    Formats a BigDecimal object into a string.
    
    Parameters:
    
    number - the BigDecimal object to be formatted
    
    Returns:
    
    a formatted string
  - format
```
public String format(BigInteger number)
```
    Formats a BigInteger object into a string.
    
    Parameters:
    
    number - the BigInteger object to be formatted
    
    Returns:
    
    a formatted string
  - format
```
public String format(double number)
```
    Formats a double number into a string.
    
    Parameters:
    
    number - the double number to be formatted
    
    Returns:
    
    a formatted string
  - format
```
public String format(long number)
```
    Formats a long number into a string.
    
    Parameters:
    
    number - the long number to be formatted
    
    Returns:
    
    a formatted string
  - format
```
public abstract StringBuffer format(BigDecimal number,
                                    StringBuffer toAppendTo,
                                    FieldPosition position)
```
    Formats a BigDecimal object into a string. Sets field position if it is needed.
    
    Parameters:
    
    number - the BigDecimal object to be formatted.
    
    toAppendTo - the string buffer to be appended with the formatted string.
    
    position - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
    
    Returns:
    
    the string buffer appended with a formatted string
  - format
```
public abstract StringBuffer format(BigInteger number,
                                    StringBuffer toAppendTo,
                                    FieldPosition position)
```
    Formats a BigInteger object into a string. Sets field position if it is needed.
    
    Parameters:
    
    number - the BigInteger object to be formatted.
    
    toAppendTo - the string buffer to be appended with the formatted string.
    
    position - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
    
    Returns:
    
    the string buffer appended with a formatted string
  - format
```
public abstract StringBuffer format(double number,
                                    StringBuffer toAppendTo,
                                    FieldPosition position)
```
    Formats a double number into a string. Sets field position if it is needed.
    
    Parameters:
    
    number - the double number to be formatted.
    
    toAppendTo - the string buffer to be appended with the formatted string.
    
    position - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
    
    Returns:
    
    the string buffer appended with a formatted string
  - format
```
public abstract StringBuffer format(long number,
                                    StringBuffer toAppendTo,
                                    FieldPosition position)
```
    Formats a long number into a string. Sets field position if it is needed.
    
    Parameters:
    
    number - the long number to be formatted.
    
    toAppendTo - the string buffer to be appended with the formatted string.
    
    position - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
    
    Returns:
    
    the string buffer appended with a formatted string
  - format
```
public StringBuffer format(Object number,
                           StringBuffer toAppendTo,
                           FieldPosition position)
```
    Formats an object into a string. Sets field position if it is needed.
    
    Specified by:
    
    format in class Format
    
    Parameters:
    
    number - the object to be formatted. It must be an instance of Number class.
    
    toAppendTo - the string buffer to be appended with the formatted string.
    
    position - to be used to get offsets of a given field in the returned string buffer. On input, the alignment field of which the offsets are to be returned. On output, the offsets of the alignment field in the returned string buffer.
    
    Returns:
    
    the string buffer appended with a formatted string
    
    Throws:
    
    IllegalArgumentException - if the given object is not an instance of Number class
  - parse
```
public Number parse(String text)
             throws ParseException
```
    Parses a string into a number.
    
    Parameters:
    
    text - the string to be parsed
    
    Returns:
    
    a Number object corresponding to the string
    
    Throws:
    
    ParseException - if the format pattern associated with this formatter is not valid for parsing or the given string cannot be parsed into a instance of Number class
  - parse
```
public abstract Number parse(String text,
                             ParsePosition parsePosition)
```
    Parses a string into a number, starting from the given parse position.
    
    Parameters:
    
    text - the string to be parsed.
    
    parsePosition - indicates where to start the parsing on input. On output, returns where the parse ends if parsing succeeds, or the start index if it fails.
    
    Returns:
    
    a Number object
  - parseObject
```
public Object parseObject(String text,
                          ParsePosition parsePosition)
```
    Parses a string into a (Number) object, starting from the given parse position. It is a convenient method which simply calls the parse(String, ParsePostion) method.
    
    Specified by:
    
    parseObject in class Format
    
    See Also:
    
    OraNumberFormat.parse(String, ParsePosition)
  - isGroupingUsed
```
public boolean isGroupingUsed()
```
    Checks if the grouping separator is used for this formatter.
    
    Returns:
    
    true if the grouping separator is used, false otherwise
  - setGroupingUsed
```
public void setGroupingUsed(boolean val)
```
    Sets the switch for grouping separator to the given boolean value.
    
    Parameters:
    
    val - the given boolean value
  - isParseIntegerOnly
```
public boolean isParseIntegerOnly()
```
    Checks if this formatter parses integer portion only.
    
    Returns:
    
    true if this formatter parses integer portion only, false otherwise
  - setParseIntegerOnly
```
public void setParseIntegerOnly(boolean val)
```
    Sets the switch for parsing integer only to the given boolean value.
    
    Parameters:
    
    val - the given boolean value
  - setMaximumIntegerDigits
```
protected void setMaximumIntegerDigits(int max)
```
  - getMinimumIntegerDigits
```
protected int getMinimumIntegerDigits()
```
  - setMinimumIntegerDigits
```
protected void setMinimumIntegerDigits(int min)
```
  - getMaximumFractionDigits
```
protected int getMaximumFractionDigits()
```
  - setMaximumFractionDigits
```
protected void setMaximumFractionDigits(int max)
```
  - getMinimumFractionDigits
```
protected int getMinimumFractionDigits()
```
  - setMinimumFractionDigits
```
protected void setMinimumFractionDigits(int min)
```
  - clone
```
public Object clone()
```
    Overrides the clone method.
    
    Overrides:
    
    clone in class Format
    
    Returns:
    
    a cloned object
  - equals
```
public boolean equals(Object obj)
```
    Overrides the equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - an object to be compared
    
    Returns:
    
    true if two objects are equal, otherwise returns false

Class OraNumberFormat

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.text.Format

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELD

INTEGER_FIELD

FRACTION_FIELD

SQLImplicit

Constructor Detail

OraNumberFormat

Method Detail

getCurrencyInstance

getCurrencyInstance

getCurrencyInstance

getDefaultCurrencyFormatPattern

getDefaultCurrencyFormatPattern

getDefaultNumberFormatPattern

getDefaultNumberFormatPattern

getInstance

getInstance

getInstance

getNumberInstance

getNumberInstance

getNumberInstance

getSQLImplicitInstance

getSQLImplicitInstance

format

format

format

format

format

format

format

format

format

parse

parse

parseObject

isGroupingUsed

setGroupingUsed

isParseIntegerOnly

setParseIntegerOnly

setMaximumIntegerDigits

getMinimumIntegerDigits

setMinimumIntegerDigits

getMaximumFractionDigits

setMaximumFractionDigits

getMinimumFractionDigits

setMinimumFractionDigits

clone

equals