Package org.apache.commons.beanutils.locale.converters

Class StringLocaleConverter

java.lang.Object

org.apache.commons.beanutils.locale.BaseLocaleConverter

org.apache.commons.beanutils.locale.converters.StringLocaleConverter

All Implemented Interfaces:

Converter, LocaleConverter

public class StringLocaleConverter
extends BaseLocaleConverter

Standard LocaleConverter implementation that converts an incoming locale-sensitive object into a java.lang.String object, optionally using a default value or throwing a ConversionException if a conversion error occurs.

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.commons.logging.Log	log	All logging goes through this logger

Fields inherited from class org.apache.commons.beanutils.locale.BaseLocaleConverter

locale, locPattern, pattern, useDefault

Constructor Summary

Constructors

Constructor	Description
StringLocaleConverter()	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
StringLocaleConverter(boolean locPattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
StringLocaleConverter(java.lang.Object defaultValue)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
StringLocaleConverter(java.lang.Object defaultValue, boolean locPattern)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
StringLocaleConverter(java.lang.Object defaultValue, java.util.Locale locale)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
StringLocaleConverter(java.lang.Object defaultValue, java.util.Locale locale, boolean locPattern)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
StringLocaleConverter(java.lang.Object defaultValue, java.util.Locale locale, java.lang.String pattern)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
StringLocaleConverter(java.lang.Object defaultValue, java.util.Locale locale, java.lang.String pattern, boolean locPattern)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
StringLocaleConverter(java.util.Locale locale)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
StringLocaleConverter(java.util.Locale locale, boolean locPattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
StringLocaleConverter(java.util.Locale locale, java.lang.String pattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
StringLocaleConverter(java.util.Locale locale, java.lang.String pattern, boolean locPattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.

Method Summary

Modifier and Type	Method	Description
private java.text.DecimalFormat	getDecimalFormat(java.util.Locale locale, java.lang.String pattern)	Make an instance of DecimalFormat.
protected java.lang.Object	parse(java.lang.Object value, java.lang.String pattern)	Convert the specified locale-sensitive input object into an output object of the specified type.

Methods inherited from class org.apache.commons.beanutils.locale.BaseLocaleConverter

convert, convert, convert, convert

Methods inherited from class java.lang.Object

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

Field Detail

log

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

All logging goes through this logger

Constructor Detail

StringLocaleConverter

public StringLocaleConverter()

Create a LocaleConverter that will throw a ConversionException if a conversion error occurs. The locale is the default locale for this instance of the Java Virtual Machine and an unlocalized pattern is used for the convertion.

StringLocaleConverter

public StringLocaleConverter(boolean locPattern)

Create a LocaleConverter that will throw a ConversionException if a conversion error occurs. The locale is the default locale for this instance of the Java Virtual Machine.

Parameters:

locPattern - Indicate whether the pattern is localized or not

StringLocaleConverter

public StringLocaleConverter(java.util.Locale locale)

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

StringLocaleConverter

public StringLocaleConverter(java.util.Locale locale,
                             boolean locPattern)

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

Parameters:

locale - The locale

locPattern - Indicate whether the pattern is localized or not

StringLocaleConverter

public StringLocaleConverter(java.util.Locale locale,
                             java.lang.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

StringLocaleConverter

public StringLocaleConverter(java.util.Locale locale,
                             java.lang.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

StringLocaleConverter

public StringLocaleConverter(java.lang.Object defaultValue)

Create a LocaleConverter that will return the specified default value if a conversion error occurs. The locale is the default locale for this instance of the Java Virtual Machine and an unlocalized pattern is used for the convertion.

Parameters:

defaultValue - The default value to be returned

StringLocaleConverter

public StringLocaleConverter(java.lang.Object defaultValue,
                             boolean locPattern)

Create a LocaleConverter that will return the specified default value if a conversion error occurs. The locale is the default locale for this instance of the Java Virtual Machine.

Parameters:

defaultValue - The default value to be returned

locPattern - Indicate whether the pattern is localized or not

StringLocaleConverter

public StringLocaleConverter(java.lang.Object defaultValue,
                             java.util.Locale locale)

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

StringLocaleConverter

public StringLocaleConverter(java.lang.Object defaultValue,
                             java.util.Locale locale,
                             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

locPattern - Indicate whether the pattern is localized or not

StringLocaleConverter

public StringLocaleConverter(java.lang.Object defaultValue,
                             java.util.Locale locale,
                             java.lang.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

StringLocaleConverter

public StringLocaleConverter(java.lang.Object defaultValue,
                             java.util.Locale locale,
                             java.lang.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

Method Detail

getDecimalFormat

private java.text.DecimalFormat getDecimalFormat(java.util.Locale locale,
                                                 java.lang.String pattern)

Make an instance of DecimalFormat.

Parameters:

locale - The locale

pattern - The pattern is used for the convertion

Returns:

The format for the locale and pattern

Throws:

ConversionException - if conversion cannot be performed successfully

java.text.ParseException - if an error occurs parsing a String to a Number

parse

protected java.lang.Object parse(java.lang.Object value,
                                 java.lang.String pattern)
                          throws java.text.ParseException

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

Specified by:

parse in class BaseLocaleConverter

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

java.text.ParseException - if an error occurs