public class

LocaleConvertUtils

extends Object
java.lang.Object
   ↳ org.apache.commons.beanutils.locale.LocaleConvertUtils

Class Overview

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 implementations for these method are provided by LocaleConvertUtilsBean. These static utility method use the default instance. More sophisticated can be provided by using a LocaleConvertUtilsBean instance.

Summary

Public Constructors
LocaleConvertUtils()
Public Methods
static Object convert(String value, Class clazz, String pattern)

Convert the specified value to an object of the specified class (if possible) using the convertion pattern.

static Object convert(String[] values, Class clazz, Locale locale, String pattern)

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

static Object convert(String value, Class clazz, Locale locale, String pattern)

Convert the specified value to an object of the specified class (if possible) using the convertion pattern.

static String convert(Object value, String pattern)

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

static String convert(Object value)

Convert the specified locale-sensitive value into a String.

static Object convert(String value, Class clazz)

Convert the specified value to an object of the specified class (if possible).

static Object convert(String[] values, Class clazz)

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

static Object convert(String[] values, Class clazz, String pattern)

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

static String convert(Object value, Locale locale, String pattern)

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

static void deregister(Class clazz, Locale locale)

Remove any registered LocaleConverter for the specified locale and Class.

static void deregister(Locale locale)

Remove any registered LocaleConverter for the specified locale.

static void deregister()

Remove any registered LocaleConverter.

static boolean getApplyLocalized()

Gets applyLocalized.

static Locale getDefaultLocale()

Gets the Locale which will be used when no Locale is passed to a method.

static LocaleConverter lookup(Class clazz, Locale locale)

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

static void register(LocaleConverter converter, Class clazz, Locale locale)

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

static void setApplyLocalized(boolean newApplyLocalized)

Sets applyLocalized.

static void setDefaultLocale(Locale locale)

Sets the Locale which will be used when no Locale is passed to a method.

Protected Methods
static FastHashMap create(Locale locale)
This method is deprecated. This method will be modified to return a Map in the next release.
static FastHashMap lookup(Locale locale)
This method is deprecated. This method will be modified to return a Map in the next release.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LocaleConvertUtils ()

Public Methods

public static Object convert (String value, Class clazz, 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.

For more details see LocaleConvertUtilsBean

Parameters
value The String scalar value to be converted
clazz The Data type to which this value should be converted.
pattern The convertion pattern
Returns
  • the converted value
See Also

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

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

For more details see LocaleConvertUtilsBean

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
Returns
  • the converted value
See Also

public static Object convert (String value, Class clazz, Locale locale, 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.

For more details see LocaleConvertUtilsBean

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
Returns
  • the converted value
See Also

public static String convert (Object value, String pattern)

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

For more details see LocaleConvertUtilsBean

Parameters
value The Value to be converted
pattern The convertion pattern
Returns
  • the converted value
See Also

public static String convert (Object value)

Convert the specified locale-sensitive value into a String.

For more details see LocaleConvertUtilsBean

Parameters
value The Value to be converted
Returns
  • the converted value
See Also

public static Object convert (String value, Class clazz)

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

For more details see LocaleConvertUtilsBean

Parameters
value The String scalar value to be converted
clazz The Data type to which this value should be converted.
Returns
  • the converted value
See Also

public static Object convert (String[] values, Class clazz)

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

For more details see LocaleConvertUtilsBean

Parameters
values Value to be converted (may be null)
clazz Java array or element class to be converted to
Returns
  • the converted value
See Also

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

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

For more details see LocaleConvertUtilsBean

Parameters
values Value to be converted (may be null)
clazz Java array or element class to be converted to
pattern The convertion pattern
Returns
  • the converted value
See Also

public static String convert (Object value, Locale locale, String pattern)

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

For more details see LocaleConvertUtilsBean

Parameters
value The Value to be converted
locale The locale
pattern The convertion pattern
Returns
  • the converted value
See Also

public static void deregister (Class clazz, Locale locale)

Remove any registered LocaleConverter for the specified locale and Class.

For more details see LocaleConvertUtilsBean

Parameters
clazz Class for which to remove a registered Converter
locale The locale
See Also

public static void deregister (Locale locale)

Remove any registered LocaleConverter for the specified locale.

For more details see LocaleConvertUtilsBean

Parameters
locale The locale
See Also

public static void deregister ()

Remove any registered LocaleConverter.

For more details see LocaleConvertUtilsBean

See Also

public static boolean getApplyLocalized ()

Gets applyLocalized.

For more details see LocaleConvertUtilsBean

Returns
  • true if pattern is localized, otherwise false
See Also

public static Locale getDefaultLocale ()

Gets the Locale which will be used when no Locale is passed to a method.

For more details see LocaleConvertUtilsBean

Returns
  • the default locale
See Also

public static LocaleConverter lookup (Class clazz, Locale locale)

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

For more details see LocaleConvertUtilsBean

Parameters
clazz Class for which to return a registered Converter
locale The Locale
Returns
  • The registered locale Converter, if any
See Also

public static void register (LocaleConverter converter, Class clazz, Locale locale)

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

For more details see LocaleConvertUtilsBean

Parameters
converter The LocaleConverter to be registered
clazz The Destination class for conversions performed by this Converter
locale The locale
See Also

public static void setApplyLocalized (boolean newApplyLocalized)

Sets applyLocalized.

For more details see LocaleConvertUtilsBean

Parameters
newApplyLocalized true if pattern is localized, otherwise false
See Also

public static void setDefaultLocale (Locale locale)

Sets the Locale which will be used when no Locale is passed to a method.

For more details see LocaleConvertUtilsBean

Parameters
locale the default locale
See Also

Protected Methods

protected static FastHashMap create (Locale locale)

This method is deprecated.
This method will be modified to return a Map in the next release.

Create all LocaleConverter types for specified locale.

For more details see LocaleConvertUtilsBean

Parameters
locale The Locale
Returns
  • The FastHashMap instance contains the all LocaleConverter types for the specified locale.
See Also

protected static FastHashMap lookup (Locale locale)

This method is deprecated.
This method will be modified to return a Map in the next release.

Look up and return any registered FastHashMap instance for the specified locale.

For more details see LocaleConvertUtilsBean

Parameters
locale The Locale
Returns
  • The FastHashMap instance contains the all LocaleConverter types for the specified locale.
See Also