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

Class DateLocaleConverter

java.lang.Object

org.apache.commons.beanutils.locale.BaseLocaleConverter

org.apache.commons.beanutils.locale.converters.DateLocaleConverter

All Implemented Interfaces:

Converter, LocaleConverter

Direct Known Subclasses:

SqlDateLocaleConverter, SqlTimeLocaleConverter, SqlTimestampLocaleConverter

public class DateLocaleConverter
extends BaseLocaleConverter

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

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	DEFAULT_PATTERN_CHARS	Default Pattern Characters
(package private) boolean	isLenient	Should the date conversion be lenient?
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
DateLocaleConverter()	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
DateLocaleConverter(boolean locPattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
DateLocaleConverter(java.lang.Object defaultValue)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
DateLocaleConverter(java.lang.Object defaultValue, boolean locPattern)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
DateLocaleConverter(java.lang.Object defaultValue, java.util.Locale locale)	Create a LocaleConverter that will return the specified default value if a conversion error occurs.
DateLocaleConverter(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.
DateLocaleConverter(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.
DateLocaleConverter(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.
DateLocaleConverter(java.util.Locale locale)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
DateLocaleConverter(java.util.Locale locale, boolean locPattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
DateLocaleConverter(java.util.Locale locale, java.lang.String pattern)	Create a LocaleConverter that will throw a ConversionException if a conversion error occurs.
DateLocaleConverter(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.lang.String	convertLocalizedPattern(java.lang.String localizedPattern, java.util.Locale locale)	Convert a pattern from a localized format to the default format.
private java.lang.String	convertPattern(java.lang.String pattern, java.lang.String fromChars, java.lang.String toChars)	Converts a Pattern from one character set to another.
private static java.lang.String	initDefaultChars()	This method is called at class initialization time to define the value for constant member DEFAULT_PATTERN_CHARS.
boolean	isLenient()	Returns whether date formatting is lenient.
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.
void	setLenient(boolean lenient)	Specify whether or not date-time parsing should be lenient.

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

DEFAULT_PATTERN_CHARS

private static final java.lang.String DEFAULT_PATTERN_CHARS

Default Pattern Characters

log

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

All logging goes through this logger

isLenient

boolean isLenient

Should the date conversion be lenient?

Constructor Detail

DateLocaleConverter

public DateLocaleConverter()

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.

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

DateLocaleConverter

public DateLocaleConverter(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

initDefaultChars

private static java.lang.String initDefaultChars()

This method is called at class initialization time to define the value for constant member DEFAULT_PATTERN_CHARS. All other methods needing this data should just read that constant.

convertLocalizedPattern

private java.lang.String convertLocalizedPattern(java.lang.String localizedPattern,
                                                 java.util.Locale locale)

Convert a pattern from a localized format to the default format.

Parameters:

locale - The locale

localizedPattern - The pattern in 'local' symbol format

Returns:

pattern in 'default' symbol format

convertPattern

private java.lang.String convertPattern(java.lang.String pattern,
                                        java.lang.String fromChars,
                                        java.lang.String toChars)

Converts a Pattern from one character set to another.

isLenient

public boolean isLenient()

Returns whether date formatting is lenient.

Returns:

true if the DateFormat used for formatting is lenient

See Also:

DateFormat.isLenient()

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 Date value

Throws:

ConversionException - if conversion cannot be performed successfully

java.text.ParseException - if an error occurs parsing

setLenient

public void setLenient(boolean lenient)

Specify whether or not date-time parsing should be lenient.

Parameters:

lenient - true if the DateFormat used for formatting should be lenient

See Also:

DateFormat.setLenient(boolean)