org.apache.commons.beanutils.converters
public abstract class DateTimeConverter extends AbstractConverter
This implementation handles conversion for the following date/time types.
java.util.Date
java.util.Calendar
java.sql.Date
java.sql.Time
java.sql.Timestamp
setUseLocaleFormat(true)
setLocale(Locale)
setPattern(String)
or
setPatterns(String[])
setPattern(String)
or
setPatterns(String[]) and...
setLocale(Locale)
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.
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 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.
|
protected DateFormat | getFormat(Locale locale, TimeZone timeZone)
Return a DateFormat |
Locale | getLocale()
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).
|
TimeZone | getTimeZone()
Return the Time Zone to use when converting dates
(or null if none specified.
|
void | setLocale(Locale locale)
Set the Locale for the Converter.
|
void | setPattern(String pattern)
Set a date format pattern to use to convert
dates to/from a java.lang.String .
|
void | setPatterns(String[] patterns)
Set the date format patterns to use to convert
dates to/from a java.lang.String .
|
void | setTimeZone(TimeZone timeZone)
Set the Time Zone to use when converting dates.
|
void | setUseLocaleFormat(boolean useLocaleFormat)
Indicate whether conversion should use a format/pattern or not.
|
String | toString()
Provide a String representation of this date/time converter.
|
ConversionException
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.
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
This method handles conversions between the following types:
java.util.Date
java.util.Calendar
java.sql.Date
java.sql.Time
java.sql.Timestamp
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
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.
null
if none specified).
Returns: The locale to use for conversion
java.lang.String
(or null
if none specified).
Returns: Array of format patterns.
See Also: SimpleDateFormat
null
if none specified.
Returns: The Time Zone.
Parameters: locale The Locale.
java.lang.String
.
Parameters: pattern The format pattern.
See Also: SimpleDateFormat
java.lang.String
.
Parameters: patterns Array of format patterns.
See Also: SimpleDateFormat
Parameters: timeZone The Time Zone.
Parameters: useLocaleFormat true
if the format
for the locale should be used, otherwise false
Returns: A String representation of this date/time converter