org.apache.commons.beanutils.converters

Class DateTimeConverter

public abstract class DateTimeConverter extends AbstractConverter

Converter implementaion that handles conversion to and from date/time objects.

This implementation handles conversion for the following date/time types.

String Conversions (to and from)

This class provides a number of ways in which date/time conversions to/from Strings can be achieved:

The Time Zone to use with the date format can be specified using the setTimeZone() method.

Since: 1.8.0

Version: $Revision: 640131 $ $Date: 2008-03-23 02:10:31 +0000 (Sun, 23 Mar 2008) $

Constructor Summary
DateTimeConverter()
Construct a Date/Time Converter that throws a ConversionException if an error occurs.
DateTimeConverter(Object defaultValue)
Construct a Date/Time Converter that returns a default value if an error occurs.
Method Summary
protected StringconvertToString(Object value)
Convert an input Date/Calendar object into a String.
protected ObjectconvertToType(Class targetType, Object value)
Convert the input object into a Date object of the specified type.
protected DateFormatgetFormat(Locale locale, TimeZone timeZone)
Return a DateFormat for the Locale.
LocalegetLocale()
Return the Locale for the Converter (or null if none specified).
String[]getPatterns()
Return the date format patterns used to convert dates to/from a java.lang.String (or null if none specified).
TimeZonegetTimeZone()
Return the Time Zone to use when converting dates (or null if none specified.
voidsetLocale(Locale locale)
Set the Locale for the Converter.
voidsetPattern(String pattern)
Set a date format pattern to use to convert dates to/from a java.lang.String.
voidsetPatterns(String[] patterns)
Set the date format patterns to use to convert dates to/from a java.lang.String.
voidsetTimeZone(TimeZone timeZone)
Set the Time Zone to use when converting dates.
voidsetUseLocaleFormat(boolean useLocaleFormat)
Indicate whether conversion should use a format/pattern or not.
StringtoString()
Provide a String representation of this date/time converter.

Constructor Detail

DateTimeConverter

public DateTimeConverter()
Construct a Date/Time Converter that throws a ConversionException if an error occurs.

DateTimeConverter

public DateTimeConverter(Object defaultValue)
Construct a Date/Time Converter that returns a default value if an error occurs.

Parameters: defaultValue The default value to be returned if the value to be converted is missing or an error occurs converting the value.

Method Detail

convertToString

protected String convertToString(Object value)
Convert an input Date/Calendar object into a String.

N.B.If the converter has been configured to with one or more patterns (using setPatterns()), then the first pattern will be used to format the date into a String. Otherwise the default DateFormat for the default locale (and style if configured) will be used.

Parameters: value The input value to be converted

Returns: the converted String value.

Throws: Throwable if an error occurs converting to a String

convertToType

protected Object convertToType(Class targetType, Object value)
Convert the input object into a Date object of the specified type.

This method handles conversions between the following types:

It also handles conversion from a String to any of the above types.

For String conversion, if the converter has been configured with one or more patterns (using setPatterns()), then the conversion is attempted with each of the specified patterns. Otherwise the default DateFormat for the default locale (and style if configured) will be used.

Parameters: targetType Data type to which this value should be converted. value The input value to be converted.

Returns: The converted value.

Throws: Exception if conversion cannot be performed successfully

getFormat

protected DateFormat getFormat(Locale locale, TimeZone timeZone)
Return a DateFormat for the Locale.

Parameters: locale The Locale to create the Format with (may be null) timeZone The Time Zone create the Format with (may be null)

Returns: A Date Format.

getLocale

public Locale getLocale()
Return the Locale for the Converter (or null if none specified).

Returns: The locale to use for conversion

getPatterns

public String[] getPatterns()
Return the date format patterns used to convert dates to/from a java.lang.String (or null if none specified).

Returns: Array of format patterns.

See Also: SimpleDateFormat

getTimeZone

public TimeZone getTimeZone()
Return the Time Zone to use when converting dates (or null if none specified.

Returns: The Time Zone.

setLocale

public void setLocale(Locale locale)
Set the Locale for the Converter.

Parameters: locale The Locale.

setPattern

public void setPattern(String pattern)
Set a date format pattern to use to convert dates to/from a java.lang.String.

Parameters: pattern The format pattern.

See Also: SimpleDateFormat

setPatterns

public void setPatterns(String[] patterns)
Set the date format patterns to use to convert dates to/from a java.lang.String.

Parameters: patterns Array of format patterns.

See Also: SimpleDateFormat

setTimeZone

public void setTimeZone(TimeZone timeZone)
Set the Time Zone to use when converting dates.

Parameters: timeZone The Time Zone.

setUseLocaleFormat

public void setUseLocaleFormat(boolean useLocaleFormat)
Indicate whether conversion should use a format/pattern or not.

Parameters: useLocaleFormat true if the format for the locale should be used, otherwise false

toString

public String toString()
Provide a String representation of this date/time converter.

Returns: A String representation of this date/time converter

Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.