| java.lang.Object
 org.apache.commons.beanutils.converters.AbstractConverter
org.apache.commons.beanutils.converters.DateTimeConverter
All known Subclasses: org.apache.commons.beanutils.converters.SqlTimeConverter, org.apache.commons.beanutils.converters.DateConverter, org.apache.commons.beanutils.converters.SqlDateConverter, org.apache.commons.beanutils.converters.SqlTimestampConverter, org.apache.commons.beanutils.converters.CalendarConverter,
| DateTimeConverter | | public class DateTimeConverter extends AbstractConverter (Code) | | org.apache.commons.beanutils.Converter implementaion
that handles conversion to and from date/time objects.
This implementation handles conversion for the following
date/time types.
java.util.Datejava.util.Calendarjava.sql.Datejava.sql.Timejava.sql.Timestamp
String Conversions (to and from)
This class provides a number of ways in which date/time
conversions to/from Strings can be achieved:
- Using the SHORT date format for the default Locale, configure using:
- Using the SHORT date format for a specified Locale, configure using:
- Using the specified date pattern(s) for the default Locale, configure using:
- Either
setPattern(String) or
setPatterns(String[])
- Using the specified date pattern(s) for a specified Locale, configure using:
setPattern(String) or
setPatterns(String[]) and...setLocale(Locale)
- If none of the above are configured the
toDate(String) method is used to convert
from String to Date and the Dates's
toString() method used to convert from
Date to String.
The Time Zone to use with the date format can be specified
using the setTimeZone() method.
version:
$Revision: 555845 $ $Date: 2007-07-13 03:52:05 +0100 (Fri, 13 Jul 2007) $
since:
1.8.0 |
| Constructor Summary | |
| public | DateTimeConverter(Class defaultType)
Construct a Date/Time Converter that throws a
ConversionException if an error occurs. | | public | DateTimeConverter(Class defaultType, Object defaultValue)
Construct a Date/Time Converter that returns a default
value if an error occurs. |
| Method Summary | |
| protected String | convertToString(Object value)
Convert an input Date/Calendar object into a String. | | 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:
java.util.Datejava.util.Calendarjava.sql.Datejava.sql.Timejava.sql.Timestamp
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.
Parameters:
value - The input value to be converted. | | protected DateFormat | getFormat(Locale locale, TimeZone timeZone)
Return a DateFormat for the Locale. | | public Locale | getLocale()
Return the Locale for the Converter
(or null if none specified). | | public String[] | getPatterns()
Return the date format patterns used to convert
dates to/from a java.lang.String
(or null if none specified). | | public TimeZone | getTimeZone()
Return the Time Zone to use when converting dates
(or null if none specified. | | public void | setLocale(Locale locale)
Set the Locale for the Converter. | | public void | setPattern(String pattern)
Set a date format pattern to use to convert
dates to/from a java.lang.String. | | public void | setPatterns(String[] patterns)
Set the date format patterns to use to convert
dates to/from a java.lang.String. | | public void | setTimeZone(TimeZone timeZone)
Set the Time Zone to use when converting dates. | | public void | setUseLocaleFormat(boolean useLocaleFormat)
Indicate whether conversion should use a format/pattern or not. | | public String | toString()
Provide a String representation of this date/time converter. |
| DateTimeConverter | | public DateTimeConverter(Class defaultType)(Code) | | Construct a Date/Time Converter that throws a
ConversionException if an error occurs.
Parameters:
defaultType - The default type this Converterhandles |
| DateTimeConverter | | public DateTimeConverter(Class defaultType, Object defaultValue)(Code) | | Construct a Date/Time Converter that returns a default
value if an error occurs.
Parameters:
defaultType - The default type this Converterhandles
Parameters:
defaultValue - The default value to be returnedif the value to be converted is missing or an erroroccurs converting the value. |
| convertToString | | protected String convertToString(Object value) throws Throwable(Code) | | 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 the converted String value.
throws:
Throwable - if an error occurs converting to a String |
| convertToType | | protected Object convertToType(Class targetType, Object value) throws Exception(Code) | | Convert the input object into a Date object of the
specified type.
This method handles conversions between the following
types:
java.util.Datejava.util.Calendarjava.sql.Datejava.sql.Timejava.sql.Timestamp
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.
Parameters:
value - The input value to be converted. The converted value.
throws:
Exception - if conversion cannot be performed successfully |
| getFormat | | protected DateFormat getFormat(Locale locale, TimeZone timeZone)(Code) | | Return a DateFormat for the Locale.
Parameters:
locale - The Locale to create the Format with (may be null)
Parameters:
timeZone - The Time Zone create the Format with (may be null) A Date Format. |
| getLocale | | public Locale getLocale()(Code) | | Return the Locale for the Converter
(or null if none specified).
The locale to use for conversion |
| getPatterns | | public String[] getPatterns()(Code) | | Return the date format patterns used to convert
dates to/from a java.lang.String
(or null if none specified).
See Also: SimpleDateFormat Array of format patterns. |
| getTimeZone | | public TimeZone getTimeZone()(Code) | | Return the Time Zone to use when converting dates
(or null if none specified.
The Time Zone. |
| setLocale | | public void setLocale(Locale locale)(Code) | | Set the Locale for the Converter.
Parameters:
locale - The Locale. |
| setPattern | | public void setPattern(String pattern)(Code) | | Set a date format pattern to use to convert
dates to/from a java.lang.String.
See Also: SimpleDateFormat
Parameters:
pattern - The format pattern. |
| setPatterns | | public void setPatterns(String[] patterns)(Code) | | Set the date format patterns to use to convert
dates to/from a java.lang.String.
See Also: SimpleDateFormat
Parameters:
patterns - Array of format patterns. |
| setTimeZone | | public void setTimeZone(TimeZone timeZone)(Code) | | Set the Time Zone to use when converting dates.
Parameters:
timeZone - The Time Zone. |
| setUseLocaleFormat | | public void setUseLocaleFormat(boolean useLocaleFormat)(Code) | | Indicate whether conversion should use a format/pattern or not.
Parameters:
useLocaleFormat - true if the formatfor the locale should be used, otherwise false |
| toString | | public String toString()(Code) | | Provide a String representation of this date/time converter.
A String representation of this date/time converter |
|
|