org.apache.commons.beanutils.locale
Class LocaleConvertUtils

java.lang.Object
  |
  +--org.apache.commons.beanutils.locale.LocaleConvertUtils

public class LocaleConvertUtils

extends java.lang.Object

Utility methods for converting locale-sensitive String scalar values to objects of the specified Class, String arrays to arrays of the specified Class and object to locale-sensitive String scalar value. The actual LocaleConverter instance to be used can be registered for each possible destination Class. Unless you override them, standard LocaleConverter instances are provided for all of the following destination Classes:

• java.lang.BigDecimal
• java.lang.BigInteger
• byte and java.lang.Byte
• double and java.lang.Double
• float and java.lang.Float
• int and java.lang.Integer
• long and java.lang.Long
• short and java.lang.Short
• java.lang.String
• java.sql.Date
• java.sql.Time
• java.sql.Timestamp

For backwards compatibility, the standard locale converters for primitive types (and the corresponding wrapper classes). If you prefer to have another LocaleConverter thrown instead, replace the standard LocaleConverter instances with ones created with the one of the appropriate constructors. It's important that LocaleConverter should be registered for the specified locale and Class (or primitive type).

Author:

Yauheny Mikulski

Field Summary

private static boolean	applyLocalized Indicate whether the pattern is localized or not
private static java.util.Locale	defaultLocale The locale - default for convertion.
private static org.apache.commons.logging.Log	log The Log instance for this class.
private static org.apache.commons.collections.FastHashMap	mapConverters Every entry of the mapConverters is: key = locale value = FastHashMap of converters for the certain locale.

Constructor Summary

LocaleConvertUtils()

Method Summary

static java.lang.String	convert(java.lang.Object value) Convert the specified locale-sensitive value into a String.
static java.lang.String	convert(java.lang.Object value, java.util.Locale locale, java.lang.String pattern) Convert the specified locale-sensitive value into a String using the paticular convertion pattern.
static java.lang.String	convert(java.lang.Object value, java.lang.String pattern) Convert the specified locale-sensitive value into a String using the convertion pattern.
static java.lang.Object	convert(java.lang.String[] values, java.lang.Class clazz, java.util.Locale locale, java.lang.String pattern) Convert an array of specified values to an array of objects of the specified class (if possible) using the convertion pattern.
static java.lang.Object	convert(java.lang.String[] values, java.lang.Class clazz, java.lang.String pattern) Convert an array of specified values to an array of objects of the specified class (if possible) using the convertion pattern.
static java.lang.Object	convert(java.lang.String value, java.lang.Class clazz) Convert the specified value to an object of the specified class (if possible).
static java.lang.Object	convert(java.lang.String value, java.lang.Class clazz, java.util.Locale locale, java.lang.String pattern) Convert the specified value to an object of the specified class (if possible) using the convertion pattern.
static java.lang.Object	convert(java.lang.String value, java.lang.Class clazz, java.lang.String pattern) Convert the specified value to an object of the specified class (if possible) using the convertion pattern.
protected static org.apache.commons.collections.FastHashMap	create(java.util.Locale locale) Create all LocaleConverter types for specified locale.
static void	deregister() Remove any registered LocaleConverter.
static void	deregister(java.lang.Class clazz, java.util.Locale locale) Remove any registered LocaleConverter for the specified locale and Class.
static void	deregister(java.util.Locale locale) Remove any registered LocaleConverter for the specified locale
static boolean	getApplyLocalized() getter for applyLocalized
static java.util.Locale	getDefaultLocale() getter for defaultLocale
static LocaleConverter	lookup(java.lang.Class clazz, java.util.Locale locale) Look up and return any registered LocaleConverter for the specified destination class and locale; if there is no registered Converter, return null.
protected static org.apache.commons.collections.FastHashMap	lookup(java.util.Locale locale) Look up and return any registered FastHashMap instance for the specified locale; if there is no registered one, return null.
static void	register(LocaleConverter converter, java.lang.Class clazz, java.util.Locale locale) Register a custom LocaleConverter for the specified destination Class, replacing any previously registered converter.
static void	setApplyLocalized(boolean newApplyLocalized) setter for applyLocalized
static void	setDefaultLocale(java.util.Locale locale) setter for defaultLocale

Methods inherited from class java.lang.Object

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

Field Detail

defaultLocale

private static java.util.Locale defaultLocale

The locale - default for convertion.

applyLocalized

private static boolean applyLocalized

Indicate whether the pattern is localized or not

log

private static org.apache.commons.logging.Log log

The Log instance for this class.

mapConverters

private static org.apache.commons.collections.FastHashMap mapConverters

Every entry of the mapConverters is: key = locale value = FastHashMap of converters for the certain locale.

Constructor Detail

LocaleConvertUtils

public LocaleConvertUtils()

Method Detail

getDefaultLocale

public static java.util.Locale getDefaultLocale()

getter for defaultLocale

setDefaultLocale

public static void setDefaultLocale(java.util.Locale locale)

setter for defaultLocale

getApplyLocalized

public static boolean getApplyLocalized()

getter for applyLocalized

setApplyLocalized

public static void setApplyLocalized(boolean newApplyLocalized)

setter for applyLocalized

convert

public static java.lang.String convert(java.lang.Object value)

Convert the specified locale-sensitive value into a String.

Parameters:

value - The Value to be converted

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.String convert(java.lang.Object value,
                                       java.lang.String pattern)

Convert the specified locale-sensitive value into a String using the convertion pattern.

Parameters:

value - The Value to be converted

pattern - The convertion pattern

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.String convert(java.lang.Object value,
                                       java.util.Locale locale,
                                       java.lang.String pattern)

Convert the specified locale-sensitive value into a String using the paticular convertion pattern.

Parameters:

value - The Value to be converted

locale - The locale

pattern - The convertion pattern

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.Object convert(java.lang.String value,
                                       java.lang.Class clazz)

Convert the specified value to an object of the specified class (if possible). Otherwise, return a String representation of the value.

Parameters:

value - The String scalar value to be converted

clazz - The Data type to which this value should be converted.

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.Object convert(java.lang.String value,
                                       java.lang.Class clazz,
                                       java.lang.String pattern)

Convert the specified value to an object of the specified class (if possible) using the convertion pattern. Otherwise, return a String representation of the value.

Parameters:

value - The String scalar value to be converted

clazz - The Data type to which this value should be converted.

pattern - The convertion pattern

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.Object convert(java.lang.String value,
                                       java.lang.Class clazz,
                                       java.util.Locale locale,
                                       java.lang.String pattern)

Convert the specified value to an object of the specified class (if possible) using the convertion pattern. Otherwise, return a String representation of the value.

Parameters:

value - The String scalar value to be converted

clazz - The Data type to which this value should be converted.

locale - The locale

pattern - The convertion pattern

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.Object convert(java.lang.String[] values,
                                       java.lang.Class clazz,
                                       java.lang.String pattern)

Convert an array of specified values to an array of objects of the specified class (if possible) using the convertion pattern.

Parameters:

values - Value to be converted (may be null)

clazz - Java array or element class to be converted to

pattern - The convertion pattern

Throws:

ConversionException - if thrown by an underlying Converter

convert

public static java.lang.Object convert(java.lang.String[] values,
                                       java.lang.Class clazz,
                                       java.util.Locale locale,
                                       java.lang.String pattern)

Convert an array of specified values to an array of objects of the specified class (if possible) using the convertion pattern.

Parameters:

values - Value to be converted (may be null)

clazz - Java array or element class to be converted to

locale - The locale

pattern - The convertion pattern

Throws:

ConversionException - if thrown by an underlying Converter

register

public static void register(LocaleConverter converter,
                            java.lang.Class clazz,
                            java.util.Locale locale)

Register a custom LocaleConverter for the specified destination Class, replacing any previously registered converter.

Parameters:

converter - The LocaleConverter to be registered

clazz - The Destination class for conversions performed by this Converter

locale - The locale

deregister

public static void deregister()

Remove any registered LocaleConverter.

deregister

public static void deregister(java.util.Locale locale)

Remove any registered LocaleConverter for the specified locale

Parameters:

locale - The locale

deregister

public static void deregister(java.lang.Class clazz,
                              java.util.Locale locale)

Remove any registered LocaleConverter for the specified locale and Class.

Parameters:

clazz - Class for which to remove a registered Converter

locale - The locale

lookup

public static LocaleConverter lookup(java.lang.Class clazz,
                                     java.util.Locale locale)

Look up and return any registered LocaleConverter for the specified destination class and locale; if there is no registered Converter, return null.

Parameters:

clazz - Class for which to return a registered Converter

locale - The Locale

lookup

protected static org.apache.commons.collections.FastHashMap lookup(java.util.Locale locale)

Look up and return any registered FastHashMap instance for the specified locale; if there is no registered one, return null.

Parameters:

locale - The Locale

Returns:

The FastHashMap instance contains the all LocaleConverter types for the specified locale.

create

protected static org.apache.commons.collections.FastHashMap create(java.util.Locale locale)

Create all LocaleConverter types for specified locale.

Parameters:

locale - The Locale

Returns:

The FastHashMap instance contains the all LocaleConverter types for the specified locale.