eve.sys

Class LocaleFormat

java.lang.Object

eve.sys.LocaleFormat

public class LocaleFormat
extends Object

This is object is used by LocaleFormatted objects when formatting their data for display in a Locale specific way. The base version of LocaleFormat provides a field to hold the Locale that should be used (which defaults to the default Locale), field to hold a format Object (usually a string specifying format) and options specific to the target object.

There are also some static methods to make it easy to format LocaleFormatted objects using default values without having to create LocaleFormat objects.

Field Summary

Fields

Modifier and Type	Field and Description
Object	format This is an optional format Object to use.
Locale	locale The locale that should be used.
static int	OPTION_IS_CURRENCY
static int	OPTION_SHOW_CURRENCY_SYMBOL
static int	OPTION_SHOW_GROUPINGS
int	options Further formatting options.

Constructor Summary

Constructors

Constructor and Description
LocaleFormat()

Method Summary

Modifier and Type	Method and Description
void	cache()
static CharArray	format(CharArray dest, LocaleFormatted data, Object format, Locale loc) Convert a LocaleFormatted data to a String, formatted for the current locale.
String	format(LocaleFormatted lf) Format a LocaleFormatted to a String.
static String	format(LocaleFormatted lf, Object format, Locale loc) Format a LocaleFormatted to a String.
static LocaleFormat	getCached(Locale loc)
LocaleFormat	getCachedCopy()
static void	parse(String formatted, LocaleFormatted lf, Object format, Locale loc) Parse a String to a LocaleFormatted Object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locale

public Locale locale

The locale that should be used.

format

public Object format

This is an optional format Object to use. The type of this value depends on the Object being formatted. An eve.math.DecimalFormat Object may be used to format a number. If it is null the LocaleFormatted object should use the default format as provided by the Locale.

OPTION_IS_CURRENCY

public static final int OPTION_IS_CURRENCY

See Also:

Constant Field Values

OPTION_SHOW_CURRENCY_SYMBOL

public static final int OPTION_SHOW_CURRENCY_SYMBOL

See Also:

Constant Field Values

OPTION_SHOW_GROUPINGS

public static final int OPTION_SHOW_GROUPINGS

See Also:

Constant Field Values

options

public int options

Further formatting options. Custom options should start at 0x1 and go up to 0x800000

Constructor Detail

LocaleFormat

public LocaleFormat()

Method Detail

getCached

public static final LocaleFormat getCached(Locale loc)

getCachedCopy

public LocaleFormat getCachedCopy()

cache

public final void cache()

format

public static CharArray format(CharArray dest,
                               LocaleFormatted data,
                               Object format,
                               Locale loc)

Convert a LocaleFormatted data to a String, formatted for the current locale. If the Object implements LocaleFormatted, the format() method will be called, otherwise a simple toString() is called.

Parameters:

dest - the destination CharArray. If it is null a new one is created and returned.

data - the LocaleFormatted Object to convert to a String.

format - a format specifier - usually a String.

loc - the locale to use for formatting. If it is null, the default Locale is used.

Returns:

the dest CharArray or a new one if it was null.

format

public static String format(LocaleFormatted lf,
                            Object format,
                            Locale loc)

Format a LocaleFormatted to a String.

Parameters:

lf - the LocaleFormatted object to format.

format - an optional format specifier - usually a String.

loc - the Locale to use for formatting.

Returns:

the LocaleFormatted object formatted as a String.

format

public String format(LocaleFormatted lf)

Format a LocaleFormatted to a String.

Parameters:

lf - the LocaleFormatted object to format.

format - an optional format specifier - usually a String.

loc - the Locale to use for formatting.

Returns:

the LocaleFormatted object formatted as a String.

parse

public static void parse(String formatted,
                         LocaleFormatted lf,
                         Object format,
                         Locale loc)
                  throws ParseException

Parse a String to a LocaleFormatted Object.

Parameters:

formatted - the formatted String.

lf - the LocaleFormatted object that will be parsing.

an - optional format specifier - usually a String.

loc - the Locale that was used for formatting.

Throws:

ParseException - on a parse error.