net.hasor.cobble.convert.convert

类 DateTimeConverter

java.lang.Object

net.hasor.cobble.convert.convert.AbstractConverter

net.hasor.cobble.convert.convert.DateTimeConverter

所有已实现的接口:

Converter

直接已知子类:

CalendarConverter, DateConverter, SqlDateConverter, SqlTimeConverter, SqlTimestampConverter

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.

• 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) 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.

从以下版本开始:

1.8.0

版本:

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

构造器概要

构造器

构造器和说明
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.

方法概要

限定符和类型	方法和说明
Object	convert(Class<?> type, Object value) Convert the input object into an output object of the specified type.
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 for the Locale.
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.

从类继承的方法 net.hasor.cobble.convert.convert.AbstractConverter

convertArray, getDefault, getDefaultType, handleError, handleMissing, isUseDefault, setDefaultValue, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

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.

参数:

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

方法详细资料

setUseLocaleFormat

public void setUseLocaleFormat(boolean useLocaleFormat)

Indicate whether conversion should use a format/pattern or not.

参数:

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

getTimeZone

public TimeZone getTimeZone()

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

返回:

The Time Zone.

setTimeZone

public void setTimeZone(TimeZone timeZone)

Set the Time Zone to use when converting dates.

参数:

timeZone - The Time Zone.

getLocale

public Locale getLocale()

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

返回:

The locale to use for conversion

setLocale

public void setLocale(Locale locale)

Set the Locale for the Converter.

参数:

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.

参数:

pattern - The format pattern.

另请参阅:

SimpleDateFormat

getPatterns

public String[] getPatterns()

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

返回:

Array of format patterns.

另请参阅:

SimpleDateFormat

setPatterns

public void setPatterns(String[] patterns)

Set the date format patterns to use to convert dates to/from a java.lang.String.

参数:

patterns - Array of format patterns.

另请参阅:

SimpleDateFormat

convert

public Object convert(Class<?> type,
                      Object value)

从类复制的说明: AbstractConverter

Convert the input object into an output object of the specified type.

指定者:

convert 在接口中 Converter

覆盖:

convert 在类中 AbstractConverter

参数:

type - Data type to which this value should be converted

value - The input value to be converted

返回:

The converted value.

convertToString

protected String convertToString(Object value)
                          throws Throwable

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.

覆盖:

convertToString 在类中 AbstractConverter

参数:

value - The input value to be converted

返回:

the converted String value.

抛出:

Throwable - if an error occurs converting to a String

convertToType

protected Object convertToType(Class<?> targetType,
                               Object value)
                        throws Exception

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

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.

指定者:

convertToType 在类中 AbstractConverter

参数:

targetType - Data type to which this value should be converted.

value - The input value to be converted.

返回:

The converted value.

抛出:

Exception - if conversion cannot be performed successfully

getFormat

protected DateFormat getFormat(Locale locale,
                               TimeZone timeZone)

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)

返回:

A Date Format.

toString

public String toString()

Provide a String representation of this date/time converter.

覆盖:

toString 在类中 AbstractConverter

返回:

A String representation of this date/time converter