Class DateTimeConverter
- All Implemented Interfaces:
Converter
- Direct Known Subclasses:
CalendarConverter
,DateConverter
,SqlDateConverter
,SqlTimeConverter
,SqlTimestampConverter
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
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:
setUseLocaleFormat(true)
- Using the SHORT date format for a specified Locale, configure using:
setLocale(Locale)
- Using the specified date pattern(s) for the default Locale, configure using:
- Either
setPattern(String)
orsetPatterns(String[])
- Using the specified date pattern(s) for a specified Locale, configure using:
setPattern(String)
orsetPatterns(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'stoString()
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:
- $Id$
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstruct a Date/Time Converter that throws aConversionException
if an error occurs.DateTimeConverter
(Object defaultValue) Construct a Date/Time Converter that returns a default value if an error occurs. -
Method Summary
Modifier and TypeMethodDescriptionprotected String
convertToString
(Object value) Convert an input Date/Calendar object into a String.protected <T> T
convertToType
(Class<T> targetType, Object value) Convert the input object into a Date object of the specified type.private DateFormat
Create a date format for the specified pattern.protected DateFormat
Return aDateFormat
for the Locale.
Return the Locale for the Converter (ornull
if none specified).String[]
Return the date format patterns used to convert dates to/from ajava.lang.String
(ornull
if none specified).Return the Time Zone to use when converting dates (ornull
if none specified.private void
logFormat
(String action, DateFormat format) Log theDateFormat
creation.
private Calendar
Parse a String date value using the set of patterns.private Calendar
parse
(Class<?> sourceType, Class<?> targetType, String value, DateFormat format) Parse a String into aCalendar
object using the specifiedDateFormat
.void
Set the Locale for the Converter.void
setPattern
(String pattern) Set a date format pattern to use to convert dates to/from ajava.lang.String
.void
setPatterns
(String[] patterns) Set the date format patterns to use to convert dates to/from ajava.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.private <T> T
Convert a long value to the specified Date type for this Converter.private <T> T
Default String to Date conversion.toString()
Provide a String representation of this date/time converter.Methods inherited from class org.apache.commons.beanutils.converters.AbstractConverter
conversionException, convert, convertArray, getDefault, getDefaultType, handleError, handleMissing, isUseDefault, log, setDefaultValue, toString
-
Field Details
-
patterns
-
displayPatterns
-
locale
-
timeZone
-
useLocaleFormat
private boolean useLocaleFormat
-
-
Constructor Details
-
DateTimeConverter
public DateTimeConverter()Construct a Date/Time Converter that throws aConversionException
if an error occurs. -
DateTimeConverter
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 Details
-
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, otherwisefalse
-
getTimeZone
Return the Time Zone to use when converting dates (ornull
if none specified.- Returns:
- The Time Zone.
-
setTimeZone
Set the Time Zone to use when converting dates.- Parameters:
timeZone
- The Time Zone.
-
getLocale
Return the Locale for the Converter (ornull
if none specified).- Returns:
- The locale to use for conversion
-
setLocale
Set the Locale for the Converter.- Parameters:
locale
- The Locale.
-
setPattern
Set a date format pattern to use to convert dates to/from ajava.lang.String
.- Parameters:
pattern
- The format pattern.- See Also:
-
getPatterns
Return the date format patterns used to convert dates to/from ajava.lang.String
(ornull
if none specified).- Returns:
- Array of format patterns.
- See Also:
-
setPatterns
Set the date format patterns to use to convert dates to/from ajava.lang.String
.- Parameters:
patterns
- Array of format patterns.- See Also:
-
convertToString
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 defaultDateFormat
for the default locale (and style if configured) will be used.- Overrides:
convertToString
in classAbstractConverter
- Parameters:
value
- The input value to be converted- Returns:
- the converted String value.
- Throws:
Throwable
- if an error occurs converting to a String
-
convertToType
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 (usingsetPatterns()
), then the conversion is attempted with each of the specified patterns. Otherwise the defaultDateFormat
for the default locale (and style if configured) will be used.- Specified by:
convertToType
in classAbstractConverter
- Type Parameters:
T
- The desired target type of the conversion.- 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
-
toDate
Convert a long value to the specified Date type for this Converter.This method handles conversion to the following types:
java.util.Date
java.util.Calendar
java.sql.Date
java.sql.Time
java.sql.Timestamp
- Type Parameters:
T
- The target type- Parameters:
type
- The Date type to convert tovalue
- The long value to convert.- Returns:
- The converted date value.
-
toDate
Default String to Date conversion.This method handles conversion from a String to the following types:
java.sql.Date
java.sql.Time
java.sql.Timestamp
N.B. No default String conversion mechanism is provided for
java.util.Date
andjava.util.Calendar
type.- Type Parameters:
T
- The target type- Parameters:
type
- The date type to convert tovalue
- The String value to convert.- Returns:
- The converted Number value.
-
getFormat
Return aDateFormat
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.
-
getFormat
Create a date format for the specified pattern.- Parameters:
pattern
- The date pattern- Returns:
- The DateFormat
-
parse
Parse a String date value using the set of patterns.- Parameters:
sourceType
- The type of the value being convertedtargetType
- The type to convert the value to.value
- The String date value.- Returns:
- The converted Date object.
- Throws:
Exception
- if an error occurs parsing the date.
-
parse
Parse a String into aCalendar
object using the specifiedDateFormat
.- Parameters:
sourceType
- The type of the value being convertedtargetType
- The type to convert the value tovalue
- The String date value.format
- The DateFormat to parse the String value.- Returns:
- The converted Calendar object.
- Throws:
ConversionException
- if the String cannot be converted.
-
toString
Provide a String representation of this date/time converter.- Overrides:
toString
in classAbstractConverter
- Returns:
- A String representation of this date/time converter
-
logFormat
Log theDateFormat
creation.
- Parameters:
action
- The action the format is being used forformat
- The Date format
-