OptionalNumberFormat (sellcom-java 1.1.0)

java.lang.Object
- java.text.Format
- - org.sellcom.core.i18n.OptionalNumberFormat

All Implemented Interfaces:

Serializable, Cloneable
```
public class OptionalNumberFormat
extends Format
```
Replacement of NumberFormat capable of handling nulls and empty strings.

Since:

1.0

See Also:

Serialized Form

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`String`	`format(double number)` Formats a `double` number.
`String`	`format(long number)` Formats a `long` number.
`StringBuffer`	`format(Object source, StringBuffer buffer, FieldPosition position)`
`static Locale[]`	`getAvailableLocales()` Returns all locales supported by the `get*Instance()` methods.
`Currency`	`getCurrency()` Returns the currency used by this format when formatting currency values.
`static OptionalNumberFormat`	`getCurrencyInstance()` Returns a currency format for the current default locale.
`static OptionalNumberFormat`	`getCurrencyInstance(Locale locale)` Returns a currency format for the given locale.
`static OptionalNumberFormat`	`getInstance()` Returns a general-purpose number format for the current default locale.
`static OptionalNumberFormat`	`getInstance(Locale locale)` Returns a general-purpose number format for the given locale.
`static OptionalNumberFormat`	`getIntegerInstance()` Returns an integer number format for the current default locale.
`static OptionalNumberFormat`	`getIntegerInstance(Locale locale)` Returns an integer number format for the given locale.
`int`	`getMaximumFractionDigits()` Returns the maximum number of digits allowed in the fraction part of a number.
`int`	`getMaximumIntegerDigits()` Returns the maximum number of digits allowed in the integer part of a number.
`int`	`getMinimumFractionDigits()` Returns the minimum number of digits allowed in the fraction part of a number.
`int`	`getMinimumIntegerDigits()` Returns the minimum number of digits allowed in the integer part of a number.
`static OptionalNumberFormat`	`getNumberInstance()` Returns a general-purpose number format for the current default locale.
`static OptionalNumberFormat`	`getNumberInstance(Locale locale)` Returns a general-purpose number format for the given locale.
`static OptionalNumberFormat`	`getPercentInstance()` Returns a percentage format for the current default locale.
`static OptionalNumberFormat`	`getPercentInstance(Locale locale)` Returns a percentage format for the given locale.
`RoundingMode`	`getRoundingMode()` Returns the rounding mode used in this format.
`int`	`hashCode()`
`boolean`	`isGroupingUsed()` Checks whether grouping is used in this format.
`boolean`	`isParseIntegerOnly()` Checks whether numbers shall be parsed as integers only.
`Object`	`parseObject(String source)`
`Object`	`parseObject(String source, ParsePosition position)`
`void`	`setCurrency(Currency currency)` Sets the currency used by this format when formatting currency values.
`void`	`setGroupingUsed(boolean value)` Sets whether grouping is used in this format.
`void`	`setMaximumFractionDigits(int value)` Sets the maximum number of digits allowed in the fraction part of a number.
`void`	`setMaximumIntegerDigits(int value)` Sets the maximum number of digits allowed in the integer part of a number.
`void`	`setMinimumFractionDigits(int value)` Sets the minimum number of digits allowed in the fraction part of a number.
`void`	`setMinimumIntegerDigits(int value)` Sets the minimum number of digits allowed in the integer part of a number.
`void`	`setParseIntegerOnly(boolean value)` Sets whether numbers shall be parsed as integers only.
`void`	`setRoundingMode(RoundingMode roundingMode)` Sets the rounding mode used in this format.

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

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

- Method Detail
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - format
```
public String format(double number)
```
    Formats a double number.
    
    Since:
    
    1.0
  - format
```
public String format(long number)
```
    Formats a long number.
    
    Since:
    
    1.0
  - format
```
public StringBuffer format(Object source,
                           StringBuffer buffer,
                           FieldPosition position)
```
    Specified by:
    
    format in class Format
  - getAvailableLocales
```
public static Locale[] getAvailableLocales()
```
    Returns all locales supported by the get*Instance() methods.
    
    Since:
    
    1.0
  - getCurrency
```
public Currency getCurrency()
```
    Returns the currency used by this format when formatting currency values.
    
    Since:
    
    1.0
  - getCurrencyInstance
```
public static OptionalNumberFormat getCurrencyInstance()
```
    Returns a currency format for the current default locale.
    
    Since:
    
    1.0
  - getCurrencyInstance
```
public static OptionalNumberFormat getCurrencyInstance(Locale locale)
```
    Returns a currency format for the given locale.
    
    Throws:
    
    IllegalArgumentException - if locale is null
    
    Since:
    
    1.0
  - getInstance
```
public static OptionalNumberFormat getInstance()
```
    Returns a general-purpose number format for the current default locale.
    
    Since:
    
    1.0
  - getInstance
```
public static OptionalNumberFormat getInstance(Locale locale)
```
    Returns a general-purpose number format for the given locale.
    
    Throws:
    
    IllegalArgumentException - if locale is null
    
    Since:
    
    1.0
  - getIntegerInstance
```
public static OptionalNumberFormat getIntegerInstance()
```
    Returns an integer number format for the current default locale.
    
    Since:
    
    1.0
  - getIntegerInstance
```
public static OptionalNumberFormat getIntegerInstance(Locale locale)
```
    Returns an integer number format for the given locale.
    
    Throws:
    
    IllegalArgumentException - if locale is null
    
    Since:
    
    1.0
  - getMaximumFractionDigits
```
public int getMaximumFractionDigits()
```
    Returns the maximum number of digits allowed in the fraction part of a number.
    
    Since:
    
    1.0
  - getMaximumIntegerDigits
```
public int getMaximumIntegerDigits()
```
    Returns the maximum number of digits allowed in the integer part of a number.
    
    Since:
    
    1.0
  - getMinimumFractionDigits
```
public int getMinimumFractionDigits()
```
    Returns the minimum number of digits allowed in the fraction part of a number.
    
    Since:
    
    1.0
  - getMinimumIntegerDigits
```
public int getMinimumIntegerDigits()
```
    Returns the minimum number of digits allowed in the integer part of a number.
    
    Since:
    
    1.0
  - getNumberInstance
```
public static OptionalNumberFormat getNumberInstance()
```
    Returns a general-purpose number format for the current default locale.
    
    Since:
    
    1.0
  - getNumberInstance
```
public static OptionalNumberFormat getNumberInstance(Locale locale)
```
    Returns a general-purpose number format for the given locale.
    
    Throws:
    
    IllegalArgumentException - if locale is null
    
    Since:
    
    1.0
  - getPercentInstance
```
public static OptionalNumberFormat getPercentInstance()
```
    Returns a percentage format for the current default locale.
    
    Since:
    
    1.0
  - getPercentInstance
```
public static OptionalNumberFormat getPercentInstance(Locale locale)
```
    Returns a percentage format for the given locale.
    
    Throws:
    
    IllegalArgumentException - if locale is null
    
    Since:
    
    1.0
  - getRoundingMode
```
public RoundingMode getRoundingMode()
```
    Returns the rounding mode used in this format.
    
    Since:
    
    1.0
  - isGroupingUsed
```
public boolean isGroupingUsed()
```
    Checks whether grouping is used in this format.
    
    Since:
    
    1.0
  - isParseIntegerOnly
```
public boolean isParseIntegerOnly()
```
    Checks whether numbers shall be parsed as integers only.
    
    Since:
    
    1.0
  - parseObject
```
public Object parseObject(String source)
                   throws ParseException
```
    Overrides:
    
    parseObject in class Format
    
    Throws:
    
    ParseException
  - parseObject
```
public Object parseObject(String source,
                          ParsePosition position)
```
    Specified by:
    
    parseObject in class Format
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setCurrency
```
public void setCurrency(Currency currency)
```
    Sets the currency used by this format when formatting currency values.
    
    Since:
    
    1.0
  - setGroupingUsed
```
public void setGroupingUsed(boolean value)
```
    Sets whether grouping is used in this format.
    
    Since:
    
    1.0
  - setMaximumFractionDigits
```
public void setMaximumFractionDigits(int value)
```
    Sets the maximum number of digits allowed in the fraction part of a number.
    
    Since:
    
    1.0
  - setMaximumIntegerDigits
```
public void setMaximumIntegerDigits(int value)
```
    Sets the maximum number of digits allowed in the integer part of a number.
    
    Since:
    
    1.0
  - setMinimumFractionDigits
```
public void setMinimumFractionDigits(int value)
```
    Sets the minimum number of digits allowed in the fraction part of a number.
    
    Since:
    
    1.0
  - setMinimumIntegerDigits
```
public void setMinimumIntegerDigits(int value)
```
    Sets the minimum number of digits allowed in the integer part of a number.
    
    Since:
    
    1.0
  - setParseIntegerOnly
```
public void setParseIntegerOnly(boolean value)
```
    Sets whether numbers shall be parsed as integers only.
    
    Since:
    
    1.0
  - setRoundingMode
```
public void setRoundingMode(RoundingMode roundingMode)
```
    Sets the rounding mode used in this format.
    
    Since:
    
    1.0

Class OptionalNumberFormat

Nested Class Summary

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

Method Summary

Methods inherited from class java.text.Format

Methods inherited from class java.lang.Object

Method Detail

equals

format

format

format

getAvailableLocales

getCurrency

getCurrencyInstance

getCurrencyInstance

getInstance

getInstance

getIntegerInstance

getIntegerInstance

getMaximumFractionDigits

getMaximumIntegerDigits

getMinimumFractionDigits

getMinimumIntegerDigits

getNumberInstance

getNumberInstance

getPercentInstance

getPercentInstance

getRoundingMode

isGroupingUsed

isParseIntegerOnly

parseObject

parseObject

hashCode

setCurrency

setGroupingUsed

setMaximumFractionDigits

setMaximumIntegerDigits

setMinimumFractionDigits

setMinimumIntegerDigits

setParseIntegerOnly

setRoundingMode