DateTimeConverter (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

javax.faces.convert
Class DateTimeConverter

java.lang.Object
  javax.faces.convert.DateTimeConverter

All Implemented Interfaces:

StateHolder, Converter

public class DateTimeConverter
extends Object
implements Converter, StateHolder

Converter implementation for java.util.Date values.

The getAsObject() method parses a String into a java.util.Date, according to the following algorithm:

• If the specified String is null, return a null. Otherwise, trim leading and trailing whitespace before proceeding.
• If the specified String - after trimming - has a zero length, return null.
• If the locale property is not null, use that Locale for managing parsing. Otherwise, use the Locale from the UIViewRoot.
• If a pattern has been specified, its syntax must conform the rules specified by java.text.SimpleDateFormat. Such a pattern will be used to parse, and the type, dateStyle, and timeStyle properties will be ignored.
• If a pattern has not been specified, parsing will be based on the type property, which expects a date value, a time value, or both. Any date and time values included will be parsed in accordance to the styles specified by dateStyle and timeStyle, respectively.
• If a timezone has been specified, it must be passed to the underlying DateFormat instance. Otherwise the "GMT" timezone is used.
• In all cases, parsing must be non-lenient; the given string must strictly adhere to the parsing format.

The getAsString() method expects a value of type java.util.Date (or a subclass), and creates a formatted String according to the following algorithm:

• If the specified value is null, return a zero-length String.
• If the specified value is a String, return it unmodified.
• If the locale property is not null, use that Locale for managing formatting. Otherwise, use the Locale from the UIViewRoot.
• If a timezone has been specified, it must be passed to the underlying DateFormat instance. Otherwise the "GMT" timezone is used.
• If a pattern has been specified, its syntax must conform the rules specified by java.text.SimpleDateFormat. Such a pattern will be used to format, and the type, dateStyle, and timeStyle properties will be ignored.
• If a pattern has not been specified, formatting will be based on the type property, which includes a date value, a time value, or both into the formatted String. Any date and time values included will be formatted in accordance to the styles specified by dateStyle and timeStyle, respectively.

Field Summary
static String	CONVERTER_ID           The standard converter id for this converter.
static String	DATE_ID           The message identifier of the FacesMessage to be created if the conversion to Date fails.
static String	DATETIME_ID           The message identifier of the FacesMessage to be created if the conversion to DateTime fails.
static String	STRING_ID           The message identifier of the FacesMessage to be created if the conversion of the DateTime value to String fails.
static String	TIME_ID           The message identifier of the FacesMessage to be created if the conversion to Time fails.

 

Constructor Summary
DateTimeConverter()

 

Method Summary
Object	getAsObject(FacesContext context, UIComponent component, String value)           Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Apply Request Values phase of the request processing lifecycle.
String	getAsString(FacesContext context, UIComponent component, Object value)           Convert the specified model object value, which is associated with the specified UIComponent, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle.
String	getDateStyle()           Return the style to be used to format or parse dates.
Locale	getLocale()           Return the Locale to be used when parsing or formatting dates and times.
String	getPattern()           Return the format pattern to be used when formatting and parsing dates and times.
String	getTimeStyle()           Return the style to be used to format or parse times.
TimeZone	getTimeZone()           Return the TimeZone used to interpret a time value.
String	getType()           Return the type of value to be formatted or parsed.
boolean	isTransient()           If true, the Object implementing this interface must not participate in state saving or restoring.
void	restoreState(FacesContext context, Object state)            Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(FacesContext context)            Gets the state of the instance as a Serializable Object.
void	setDateStyle(String dateStyle)           Set the style to be used to format or parse dates.
void	setLocale(Locale locale)           Set the Locale to be used when parsing or formatting dates and times.
void	setPattern(String pattern)           Set the format pattern to be used when formatting and parsing dates and times.
void	setTimeStyle(String timeStyle)           Set the style to be used to format or parse times.
void	setTimeZone(TimeZone timeZone)           Set the TimeZone used to interpret a time value.
void	setTransient(boolean transientFlag)           Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.
void	setType(String type)           Set the type of value to be formatted or parsed.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

CONVERTER_ID

public static final String CONVERTER_ID

The standard converter id for this converter.

See Also:

Constant Field Values

DATE_ID

public static final String DATE_ID

The message identifier of the FacesMessage to be created if the conversion to Date fails. The message format string for this message may optionally include the following placeholders:

• {0} replaced by the unconverted value.
• {1} replaced by an example value.
• {2} replaced by a String whose value is the label of the input component that produced this message.

See Also:

Constant Field Values

TIME_ID

public static final String TIME_ID

The message identifier of the FacesMessage to be created if the conversion to Time fails. The message format string for this message may optionally include the following placeholders:

• {0} replaced by the unconverted value.
• {1} replaced by an example value.
• {2} replaced by a String whose value is the label of the input component that produced this message.

See Also:

Constant Field Values

DATETIME_ID

public static final String DATETIME_ID

The message identifier of the FacesMessage to be created if the conversion to DateTime fails. The message format string for this message may optionally include the following placeholders:

• {0} replaced by the unconverted value.
• {1} replaced by an example value.
• {2} replaced by a String whose value is the label of the input component that produced this message.

See Also:

Constant Field Values

STRING_ID

public static final String STRING_ID

The message identifier of the FacesMessage to be created if the conversion of the DateTime value to String fails. The message format string for this message may optionally include the following placeholders:

• {0} relaced by the unconverted value.
• {1} replaced by a String whose value is the label of the input component that produced this message.

See Also:

Constant Field Values

DateTimeConverter

public DateTimeConverter()

getDateStyle

public String getDateStyle()

Return the style to be used to format or parse dates. If not set, the default value, default, is returned.

public void setDateStyle(String dateStyle)

public Locale getLocale()

public void setLocale(Locale locale)

public String getPattern()

public void setPattern(String pattern)

public String getTimeStyle()

public void setTimeStyle(String timeStyle)

public TimeZone getTimeZone()

public void setTimeZone(TimeZone timeZone)

public String getType()

public void setType(String type)

public Object getAsObject(FacesContext context,
                          UIComponent component,
                          String value)

public String getAsString(FacesContext context,
                          UIComponent component,
                          Object value)

public Object saveState(FacesContext context)

public void restoreState(FacesContext context,
                         Object state)

public boolean isTransient()

public void setTransient(boolean transientFlag)