org.apache.commons.beanutils.locale

Class BaseLocaleConverter

Implemented Interfaces:
Converter, LocaleConverter
Known Direct Subclasses:
DateLocaleConverter, DecimalLocaleConverter, StringLocaleConverter

public abstract class BaseLocaleConverter
extends java.lang.Object
implements LocaleConverter

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.
Author:
Yauheny Mikulski

Field Summary

private Object
defaultValue
The default value specified to our Constructor, if any.
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.
private static Log
log
All logging goes through this logger
protected String
pattern
The default pattern specified to our Constructor, if any.
protected boolean
useDefault
Should we return the default value on conversion errors?

Constructor Summary

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.
BaseLocaleConverter(Object defaultValue, Locale locale, String pattern, boolean useDefault, boolean locPattern)
Create a LocaleConverter that will return the specified default value or throw a ConversionException if a conversion error occurs.

Method Summary

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.
Object
convert(Object value)
Convert the specified locale-sensitive input object into an output object.
Object
convert(Object value, String pattern)
Convert the specified locale-sensitive input object into an output object.
protected abstract Object
parse(Object value, String pattern)
Convert the specified locale-sensitive input object into an output object of the specified type.

Field Details

defaultValue

private Object defaultValue
The default value specified to our Constructor, if any.

locPattern

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

locale

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

log

private static Log log
All logging goes through this logger

pattern

protected String pattern
The default pattern specified to our Constructor, if any.

useDefault

protected boolean useDefault
Should we return the default value on conversion errors?

Constructor Details

BaseLocaleConverter

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

BaseLocaleConverter

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

BaseLocaleConverter

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

BaseLocaleConverter

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

BaseLocaleConverter

private BaseLocaleConverter(Object defaultValue,
                            Locale locale,
                            String pattern,
                            boolean useDefault,
                            boolean locPattern)
Create a LocaleConverter that will return the specified default value or throw a ConversionException if a conversion error occurs.
Parameters:
defaultValue - The default value to be returned
locale - The locale
pattern - The convertion pattern
useDefault - Indicate whether the default value is used or not
locPattern - Indicate whether the pattern is localized or not

Method Details

convert

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.
Specified by:
convert in interface Converter
Parameters:
type - Data type to which this value should be converted
value - The input object to be converted

convert

public Object convert(Class type,
                      Object value,
                      String pattern)
Convert the specified locale-sensitive input object into an output object of the specified type.
Specified by:
convert in interface LocaleConverter
Parameters:
type - Data type to which this value should be converted
value - The input object to be converted
pattern - The pattern is used for the convertion

convert

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

convert

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

parse

protected abstract Object parse(Object value,
                                String pattern)
            throws ParseException
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

Copyright (c) 2001-2004 - Apache Software Foundation