java.lang.Object | ||
↳ | org.apache.commons.beanutils.converters.AbstractConverter | |
↳ | org.apache.commons.beanutils.converters.DateTimeConverter |
Known Direct Subclasses |
Converter
implementaion
that handles conversion to and from date/time objects.
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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a Date/Time Converter that throws a
ConversionException if an error occurs. | |||||||||||
Construct a Date/Time Converter that returns a default
value if an error occurs.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return the Locale for the Converter
(or
null if none specified). | |||||||||||
Return the date format patterns used to convert
dates to/from a
java.lang.String
(or null if none specified). | |||||||||||
Return the Time Zone to use when converting dates
(or
null if none specified. | |||||||||||
Set the Locale for the Converter.
| |||||||||||
Set a date format pattern to use to convert
dates to/from a
java.lang.String . | |||||||||||
Set the date format patterns to use to convert
dates to/from a
java.lang.String . | |||||||||||
Set the Time Zone to use when converting dates.
| |||||||||||
Indicate whether conversion should use a format/pattern or not.
| |||||||||||
Provide a String representation of this date/time converter.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Convert an input Date/Calendar object into a String.
| |||||||||||
Convert the input object into a Date object of the
specified type.
| |||||||||||
Return a
DateFormat |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.beanutils.converters.AbstractConverter
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.apache.commons.beanutils.Converter
|
Construct a Date/Time Converter that throws a
ConversionException
if an error occurs.
Construct a Date/Time Converter that returns a default value if an error occurs.
defaultValue | The default value to be returned if the value to be converted is missing or an error occurs converting the value. |
---|
Return the Locale for the Converter
(or null
if none specified).
Return the date format patterns used to convert
dates to/from a java.lang.String
(or null
if none specified).
Return the Time Zone to use when converting dates
(or null
if none specified.
Set the Locale for the Converter.
locale | The Locale. |
---|
Set a date format pattern to use to convert
dates to/from a java.lang.String
.
pattern | The format pattern. |
---|
Set the date format patterns to use to convert
dates to/from a java.lang.String
.
patterns | Array of format patterns. |
---|
Set the Time Zone to use when converting dates.
timeZone | The Time Zone. |
---|
Indicate whether conversion should use a format/pattern or not.
useLocaleFormat | true if the format
for the locale should be used, otherwise false
|
---|
Provide a String representation of this date/time converter.
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.
value | The input value to be converted |
---|
Throwable | if an error occurs converting to a String |
---|
Convert the input object into a Date object of the specified type.
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.
targetType | Data type to which this value should be converted. |
---|---|
value | The input value to be converted. |
Exception | if conversion cannot be performed successfully |
---|
Return a DateFormat
for the Locale.
locale | The Locale to create the Format with (may be null) |
---|---|
timeZone | The Time Zone create the Format with (may be null) |