public abstract class

BaseLocaleConverter

extends Object
implements LocaleConverter
java.lang.Object
   ↳ org.apache.commons.beanutils.locale.BaseLocaleConverter
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

The base class for all standart type locale-sensitive converters. It has LocaleConverter and Converter implementations, that convert an incoming locale-sensitive Object into an object of correspond type, optionally using a default value or throwing a ConversionException if a conversion error occurs.

Summary

Fields
protected boolean locPattern The flag indicating whether the given pattern string is localized or not.
protected Locale locale The locale specified to our Constructor, by default - system locale.
protected String pattern The default pattern specified to our Constructor, if any.
protected boolean useDefault Should we return the default value on conversion errors?
Protected Constructors
BaseLocaleConverter(Locale locale, String pattern)
Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
BaseLocaleConverter(Locale locale, String pattern, boolean locPattern)
Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
BaseLocaleConverter(Object defaultValue, Locale locale, String pattern)
Create a LocaleConverter that will return the specified default value if a conversion error occurs.
BaseLocaleConverter(Object defaultValue, Locale locale, String pattern, boolean locPattern)
Create a LocaleConverter that will return the specified default value if a conversion error occurs.
Public Methods
Object convert(Object value, String pattern)
Convert the specified locale-sensitive input object into an output object.
Object convert(Object value)
Convert the specified locale-sensitive input object into an output object.
Object convert(Class type, Object value)
Convert the specified locale-sensitive input object into an output object of the specified type.
Object convert(Class type, Object value, String pattern)
Convert the specified locale-sensitive input object into an output object of the specified type.
Protected Methods
abstract Object parse(Object value, String pattern)
Convert the specified locale-sensitive input object into an output object of the specified type.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.commons.beanutils.Converter
From interface org.apache.commons.beanutils.locale.LocaleConverter

Fields

protected boolean locPattern

The flag indicating whether the given pattern string is localized or not.

protected Locale locale

The locale specified to our Constructor, by default - system locale.

protected String pattern

The default pattern specified to our Constructor, if any.

protected boolean useDefault

Should we return the default value on conversion errors?

Protected Constructors

protected BaseLocaleConverter (Locale locale, String pattern)

Create a LocaleConverter that will throw a ConversionException if a conversion error occurs. An unlocalized pattern is used for the convertion.

Parameters
locale The locale
pattern The convertion pattern

protected BaseLocaleConverter (Locale locale, String pattern, boolean locPattern)

Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.

Parameters
locale The locale
pattern The convertion pattern
locPattern Indicate whether the pattern is localized or not

protected BaseLocaleConverter (Object defaultValue, Locale locale, String pattern)

Create a LocaleConverter that will return the specified default value if a conversion error occurs. An unlocalized pattern is used for the convertion.

Parameters
defaultValue The default value to be returned
locale The locale
pattern The convertion pattern

protected BaseLocaleConverter (Object defaultValue, Locale locale, String pattern, boolean locPattern)

Create a LocaleConverter that will return the specified default value if a conversion error occurs.

Parameters
defaultValue The default value to be returned
locale The locale
pattern The convertion pattern
locPattern Indicate whether the pattern is localized or not

Public Methods

public Object convert (Object value, String pattern)

Convert the specified locale-sensitive input object into an output object.

Parameters
value The input object to be converted
pattern The pattern is used for the convertion
Returns
  • The converted value
Throws
ConversionException if conversion cannot be performed successfully

public Object convert (Object value)

Convert the specified locale-sensitive input object into an output object. The default pattern is used for the convertion.

Parameters
value The input object to be converted
Returns
  • The converted value
Throws
ConversionException if conversion cannot be performed successfully

public Object convert (Class type, Object value)

Convert the specified locale-sensitive input object into an output object of the specified type. The default pattern is used for the convertion.

Parameters
type Data type to which this value should be converted
value The input object to be converted
Returns
  • The converted value
Throws
ConversionException if conversion cannot be performed successfully

public Object convert (Class type, Object value, String pattern)

Convert the specified locale-sensitive input object into an output object of the specified type.

Parameters
type Data is type to which this value should be converted
value is the input object to be converted
pattern is the pattern is used for the conversion; if null is passed then the default pattern associated with the converter object will be used.
Returns
  • The converted value
Throws
ConversionException if conversion cannot be performed successfully

Protected Methods

protected abstract Object parse (Object value, String pattern)

Convert the specified locale-sensitive input object into an output object of the specified type.

Parameters
value The input object to be converted
pattern The pattern is used for the convertion
Returns
  • The converted value
Throws
ParseException if conversion cannot be performed successfully