FormatterFactory (josef 3.2.5 API)

java.lang.Object
- org.josef.util.FormatterFactory

```
@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
public final class FormatterFactory
extends Object
```
A Factory for the different ....Format classes in the java.text package.
Every returned ....Format object is based upon a pattern. When not supplied, the patterns are fetched from the Formatter.properties resource bundle. Every method in this class always creates a new instance. Sun suggests to reuse the created instances and this is exactly what Formatter does. Note: This class allows for localized patterns in date/times. In the Netherlands for example we use the pattern: jjjj-mm-dd. Where the 'jjjj' represents the year. Formatting numbers, never uses a localized pattern. Supply the English pattern instead to localize numbers. In the Netherlands we use a comma as a decimal separator, so the pattern '##,###,###.##' would format the number 12345678.90 as '12.345.678,90', using a Dutch locale and as '12,456,78.90' using a US locale. The patterns for decimals are not localized as they are currently not used in messages.

Version:

1.0 $Revision: 6492 $

Author:

Kees Schotanus

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_DATE_PATTERN` Key to the default date pattern in the resource bundle.
`static String`	`KEY_DATE_PATTERN_UNLOCALIZED` Key to the default date pattern in the resource bundle.
`static String`	`KEY_DATE_TIME_PATTERN` Key to the default date/time pattern in the resource bundle.
`static String`	`KEY_DATE_TIME_PATTERN_HMS` Key to the default date/time pattern in the resource bundle.
`static String`	`KEY_DECIMAL_PATTERN` Key to the default decimal number pattern in the resource bundle.
`static String`	`KEY_INTEGER_PATTERN` Key to the default integer number pattern in the resource bundle.
`static String`	`KEY_LOCAL_PATTERN_CHARS` Key to the local pattern characters.
`static String`	`KEY_MONTH_YEAR_PATTERN` Key to the default month/year pattern in the resource bundle.
`static String`	`KEY_MONTH_YEAR_PATTERN_UNLOCALIZED` Key to the default month/year pattern in the resource bundle.
`static String`	`KEY_SHORT_DATE_PATTERN` Key to the default short date pattern in the resource bundle.
`static String`	`KEY_SHORT_DATE_TIME_PATTERN` Key to the default short date/time pattern in the resource bundle.
`static String`	`KEY_TIME_PATTERN` Key to the default time pattern in the resource bundle.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static NumberFormat`	`createBigDecimalFormat(Locale locale, String pattern)` Creates a `NumberFormat` object suitable for formatting and parsing BigDecimal numbers, based upon the supplied pattern.
`static SimpleDateFormat`	`createDateFormat(Locale locale, String pattern)` Creates a `SimpleDateFormat` object suitable for formatting and parsing dates, based upon the supplied pattern.
`static SimpleDateFormat`	`createDateTimeFormat(Locale locale, TimeZone timeZone, String pattern)` Creates a `SimpleDateFormat` object suitable for formatting and parsing date/times, based upon the supplied pattern.
`static NumberFormat`	`createDecimalFormat(Locale locale, String pattern)` Creates a `NumberFormat` object suitable for formatting and parsing decimal numbers, based upon the supplied pattern.
`static NumberFormat`	`createDefaultBigDecimalFormat(Locale locale)` Creates a default `NumberFormat` object suitable for formatting and parsing BigDecimal numbers.
`static DateFormat`	`createDefaultDateFormat(Locale locale)` Creates a default `DateFormat` object suitable for formatting and parsing `Dates`.
`static DateFormat`	`createDefaultDateTimeFormat(Locale locale, TimeZone timeZone)` Creates a default `DateFormat` object suitable for formatting and parsing date/times.
`static NumberFormat`	`createDefaultDecimalFormat(Locale locale)` Creates a default `NumberFormat` object suitable for formatting and parsing decimal numbers.
`static NumberFormat`	`createDefaultIntegerFormat(Locale locale)` Creates a default `NumberFormat` object suitable for formatting integer numbers.
`static DateFormat`	`createDefaultShortDateFormat(Locale locale)` Creates a default `DateFormat` object suitable for formatting and parsing short dates.
`static DateFormat`	`createDefaultShortDateTimeFormat(Locale locale, TimeZone timeZone)` Creates a default `DateFormat` object suitable for formatting and parsing short date/times.
`static DateFormat`	`createDefaultTimeFormat(Locale locale)` Creates a default `DateFormat` object suitable for formatting and parsing times.
`static NumberFormat`	`createIntegerFormat(Locale locale, String pattern)` Creates a `NumberFormat` object suitable for formatting and parsing integer numbers, based upon the supplied pattern.
`static SimpleDateFormat`	`createTimeFormat(Locale locale, String pattern)` Creates a `SimpleDateFormat` object suitable for formatting and parsing times, based upon the supplied pattern.
`static String`	`getLocalPatternChars(Locale locale)` Gets the local pattern characters that are used to format date/times.
`static boolean`	`isLocalizedPattern(Locale locale, String pattern)` Determines whether the supplied date/time pattern is a localized pattern or not.

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

- Field Detail
  - KEY_LOCAL_PATTERN_CHARS
```
public static final String KEY_LOCAL_PATTERN_CHARS
```
    Key to the local pattern characters.
    
    See Also:
    
    Constant Field Values
  - KEY_DATE_PATTERN
```
public static final String KEY_DATE_PATTERN
```
    Key to the default date pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_DATE_PATTERN_UNLOCALIZED
```
public static final String KEY_DATE_PATTERN_UNLOCALIZED
```
    Key to the default date pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_DATE_TIME_PATTERN
```
public static final String KEY_DATE_TIME_PATTERN
```
    Key to the default date/time pattern in the resource bundle. This pattern shows hours and minutes.
    
    See Also:
    
    Constant Field Values
  - KEY_DATE_TIME_PATTERN_HMS
```
public static final String KEY_DATE_TIME_PATTERN_HMS
```
    Key to the default date/time pattern in the resource bundle. This pattern shows hours and minutes and seconds.
    
    See Also:
    
    Constant Field Values
  - KEY_DECIMAL_PATTERN
```
public static final String KEY_DECIMAL_PATTERN
```
    Key to the default decimal number pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_INTEGER_PATTERN
```
public static final String KEY_INTEGER_PATTERN
```
    Key to the default integer number pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_MONTH_YEAR_PATTERN
```
public static final String KEY_MONTH_YEAR_PATTERN
```
    Key to the default month/year pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_MONTH_YEAR_PATTERN_UNLOCALIZED
```
public static final String KEY_MONTH_YEAR_PATTERN_UNLOCALIZED
```
    Key to the default month/year pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_SHORT_DATE_PATTERN
```
public static final String KEY_SHORT_DATE_PATTERN
```
    Key to the default short date pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_SHORT_DATE_TIME_PATTERN
```
public static final String KEY_SHORT_DATE_TIME_PATTERN
```
    Key to the default short date/time pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
  - KEY_TIME_PATTERN
```
public static final String KEY_TIME_PATTERN
```
    Key to the default time pattern in the resource bundle.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - createDefaultDateFormat
```
public static DateFormat createDefaultDateFormat(Locale locale)
```
    Creates a default DateFormat object suitable for formatting and parsing Dates.
    The DateFormat object is set to not lenient so non existing dates like February 30th won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    Returns:
    
    Default DateFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property ile, a log message is written and a DateFormat object using the DateFormat.SHORT style is returned.
    
    Throws:
    
    NullPointerException - When the supplied locale is null.
  - createDefaultShortDateFormat
```
public static DateFormat createDefaultShortDateFormat(Locale locale)
```
    Creates a default DateFormat object suitable for formatting and parsing short dates.
    The DateFormat object is set to not lenient so non existing dates like February 30th won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    Returns:
    
    Default DateFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property file, a log message is written and a DateFormat object using the DateFormat.SHORT style is returned.
  - createDateFormat
```
public static SimpleDateFormat createDateFormat(Locale locale,
                                                String pattern)
```
    Creates a SimpleDateFormat object suitable for formatting and parsing dates, based upon the supplied pattern.
    The SimpleDateFormat object is set to not lenient so non existing dates won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    pattern - The pattern to use for formatting and parsing dates.
    This may either be a non-localized pattern like: yyyy-MM-dd or a localized pattern like: jjjj-MM-dd. In this latter pattern the letter 'j' would be the Dutch symbol for a year.
    
    Returns:
    
    A SimpleDateFormat object initialized with the supplied pattern.
    
    Throws:
    
    NullPointerException - When either the supplied locale or pattern is null.
  - createDefaultDateTimeFormat
```
public static DateFormat createDefaultDateTimeFormat(Locale locale,
                                                     TimeZone timeZone)
```
    Creates a default DateFormat object suitable for formatting and parsing date/times.
    The DateFormat object is set to not lenient so non existing date/times won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    timeZone - Time zone used for this formatter.
    
    Returns:
    
    Default DateFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property file, a log message is written and a DateFormat object using the DateFormat.SHORT style (for both date and time) is returned.
    
    Throws:
    
    NullPointerException - When either the supplied locale or timeZone is null.
  - createDefaultShortDateTimeFormat
```
public static DateFormat createDefaultShortDateTimeFormat(Locale locale,
                                                          TimeZone timeZone)
```
    Creates a default DateFormat object suitable for formatting and parsing short date/times.
    The DateFormat object is set to not lenient so non existing date/times won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    timeZone - Time zone used for this formatter.
    
    Returns:
    
    Default DateFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property file, a log message is written and a DateFormat object using the DateFormat.SHORT style (for both date and time) is returned.
    
    Throws:
    
    NullPointerException - When either the supplied locale or timeZone is null.
  - createDateTimeFormat
```
public static SimpleDateFormat createDateTimeFormat(Locale locale,
                                                    TimeZone timeZone,
                                                    String pattern)
```
    Creates a SimpleDateFormat object suitable for formatting and parsing date/times, based upon the supplied pattern.
    The SimpleDateFormat object is set to not lenient so non existing date/times won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    timeZone - Time zone used for this formatter.
    
    pattern - The pattern to use for formatting and parsing date/times.
    This may either be a non-localized pattern like: yyyy-MM-dd or a localized pattern like: jjjj-MM-dd. In this latter pattern the letter 'j' would be the Dutch symbol for a year.
    
    Returns:
    
    A SimpleDateFormat object initialized with the supplied pattern.
    
    Throws:
    
    NullPointerException - When either the supplied locale, timeZone or pattern is null.
  - createDefaultBigDecimalFormat
```
public static NumberFormat createDefaultBigDecimalFormat(Locale locale)
```
    Creates a default NumberFormat object suitable for formatting and parsing BigDecimal numbers.
    The returned formatter is equal to the formatter created by createDefaultDecimalFormat(Locale), except for the fact that parsing a value will result in a BigDecimal.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    Returns:
    
    Default NumberFormat object initialized with a localized pattern.
    
    See Also:
    
    createDefaultDecimalFormat(Locale)
  - createBigDecimalFormat
```
public static NumberFormat createBigDecimalFormat(Locale locale,
                                                  String pattern)
```
    Creates a NumberFormat object suitable for formatting and parsing BigDecimal numbers, based upon the supplied pattern.
    The returned formatter is equal to the formatter created by createDecimalFormat(Locale, String), except for the fact that parsing a value will result in a BigDecimal.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    pattern - The pattern to use for formatting and parsing BigDecimal numbers.
    
    Returns:
    
    NumberFormat object initialized with a localized pattern.
  - createDefaultDecimalFormat
```
public static NumberFormat createDefaultDecimalFormat(Locale locale)
```
    Creates a default NumberFormat object suitable for formatting and parsing decimal numbers.
    In contrast with Sun's default decimal formatting, this instance uses RoundingMode.HALF_UP rounding.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    Returns:
    
    Default NumberFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property file, a log message is written and a standard DecimalFormat object using 2 decimal places is returned.
  - createDecimalFormat
```
public static NumberFormat createDecimalFormat(Locale locale,
                                               String pattern)
```
    Creates a NumberFormat object suitable for formatting and parsing decimal numbers, based upon the supplied pattern.
    In contrast with Sun's default decimal formatting, this instance uses RoundingMode.HALF_UP rounding.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    pattern - The pattern to use for formatting and parsing decimal numbers.
    
    Returns:
    
    NumberFormat object initialized with a localized pattern.
  - createDefaultIntegerFormat
```
public static NumberFormat createDefaultIntegerFormat(Locale locale)
```
    Creates a default NumberFormat object suitable for formatting integer numbers.
    In contrast with Sun's default formatting, this instance uses RoundingMode.HALF_UP rounding.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    Returns:
    
    Default NumberFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property file, a log message is written and a standard NumberFormat object using 0 decimal places is returned.
  - createIntegerFormat
```
public static NumberFormat createIntegerFormat(Locale locale,
                                               String pattern)
```
    Creates a NumberFormat object suitable for formatting and parsing integer numbers, based upon the supplied pattern.
    In contrast with Sun's default decimal formatting, this instance uses RoundingMode.HALF_UP rounding.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    pattern - The pattern to use for formatting and parsing integer numbers.
    
    Returns:
    
    NumberFormat object initialized with a localized pattern.
  - createDefaultTimeFormat
```
public static DateFormat createDefaultTimeFormat(Locale locale)
```
    Creates a default DateFormat object suitable for formatting and parsing times.
    The DateFormat object is set to not lenient so non existing times won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    Returns:
    
    Default DateFormat object initialized with a localized pattern.
    When the localized pattern could not be retrieved from the property file, a log message is written and a DateFormat object using the DateFormat.SHORT style is returned.
  - createTimeFormat
```
public static SimpleDateFormat createTimeFormat(Locale locale,
                                                String pattern)
```
    Creates a SimpleDateFormat object suitable for formatting and parsing times, based upon the supplied pattern.
    The SimpleDateFormat object is set to not lenient so non existing times won't be accepted.
    
    Parameters:
    
    locale - Locale to be used for this formatter.
    
    pattern - The pattern to use for formatting and parsing times.
    This may either be a non-localized pattern like: HH:mm or a localized pattern like: UU:MM. In this latter pattern the letter 'U' would be the Dutch symbol for an hour.
    
    Returns:
    
    A SimpleDateFormat object initialized with the supplied pattern.
    
    Throws:
    
    NullPointerException - When either the supplied locale or pattern is null.
  - getLocalPatternChars
```
public static String getLocalPatternChars(Locale locale)
```
    Gets the local pattern characters that are used to format date/times.
    
    Parameters:
    
    locale - Locale to get the local pattern characters for.
    
    Returns:
    
    The local pattern characters or null when the local pattern characters should not be used.
  - isLocalizedPattern
```
public static boolean isLocalizedPattern(Locale locale,
                                         String pattern)
```
    Determines whether the supplied date/time pattern is a localized pattern or not.
    A pattern is a localized pattern when all of the alphabetic characters in the supplied pattern occur in the list of localized pattern characters.
    A pattern like: dd-MM-yyyy for example would be written as: dd-mm-jjjj in Dutch. The allowable characters per locale can be found in the Formatter_??.properties file.
    
    Parameters:
    
    locale - Locale used to get the local pattern characters.
    
    pattern - The pattern to check.
    
    Returns:
    
    True when the supplied pattern is a localized pattern, otherwise false is returned.
    
    Throws:
    
    NullPointerException - When either the supplied locale or pattern is null.

Class FormatterFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_LOCAL_PATTERN_CHARS

KEY_DATE_PATTERN

KEY_DATE_PATTERN_UNLOCALIZED

KEY_DATE_TIME_PATTERN

KEY_DATE_TIME_PATTERN_HMS

KEY_DECIMAL_PATTERN

KEY_INTEGER_PATTERN

KEY_MONTH_YEAR_PATTERN

KEY_MONTH_YEAR_PATTERN_UNLOCALIZED

KEY_SHORT_DATE_PATTERN

KEY_SHORT_DATE_TIME_PATTERN

KEY_TIME_PATTERN

Method Detail

createDefaultDateFormat

createDefaultShortDateFormat

createDateFormat

createDefaultDateTimeFormat

createDefaultShortDateTimeFormat

createDateTimeFormat

createDefaultBigDecimalFormat

createBigDecimalFormat

createDefaultDecimalFormat

createDecimalFormat

createDefaultIntegerFormat

createIntegerFormat

createDefaultTimeFormat

createTimeFormat

getLocalPatternChars

isLocalizedPattern