oracle.apps.fnd.applcore.i18n.text
Class DateFormatter

java.lang.Object
  oracle.apps.fnd.applcore.i18n.text.DateFormatter

public abstract class DateFormatter
extends java.lang.Object

DateFormatter is an abstract class which defines the method for date formatting and parsing based on the user preferences.

The APIs should be called only the case ADF Faces date formatting function cannot be utilize.

Synchronization

DateFormatter and its subclasses are generally not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.

Example

 // For date formatting and parsing.
 DateFormatter formatter = DateFormatter.getInstance(FormatUtil
     .getI18NContext(ApplSessionUtil.getSession()), DateFormatter.DATE);

 // or
 // DateFormatter formater =
 //   FormatUtil.getDateInstance(ApplSessionUtil.getSession());
 java.util.Date date = new java.util.Date();

 String formattedString = formatter.format(date);

 java.util.Date parsedDate = formatter.parse(formattedString);

 // For datetime formatting and parsing.
 DateFormatter formatter = DateFormatter.getInstance(FormatUtil
     .getI18NContext(ApplSessionUtil.getSession()), DateFormatter.DATETIME);

 // or
 // DateFormatter formater =
 //   FormatUtil.getDateTimeInstance(ApplSessionUtil.getSession());
 java.util.Date datetime = new java.util.Date();

 String formattedString = formatter.format(datetime);

 java.util.Date parsedDate = formatter.parse(formattedString);

 // For time formatting. Do not parse for time as it returns incorrect
 // Date object because of no date information.
 DateFormatter formatter = DateFormatter.getInstance(FormatUtil
     .getI18NContext(ApplSessionUtil.getSession()), DateFormatter.TIME);

 // or
 // DateFormatter formater =
 //   FormatUtil.getTimeInstance(ApplSessionUtil.getSession());
 java.util.Date time = new java.util.Date();

 String formattedString = formatter.format(time);
 

Field Summary

static int	DATE Constant indicating date type.
static int	DATETIME Constant indicating datetime type.
static int	TIME Constant indicating time type.

Constructor Summary

DateFormatter()

Method Summary

abstract java.lang.String	format(java.util.Date date) Returns formatted date string based on the user preferences.
static DateFormatter	getInstance(I18NContext context, int type) Returns DateFormatter instance based on the type specified.
static DateFormatter	getInstance(I18NContext context, int type, java.util.TimeZone timezone) Returns DateFormatter instance based on the type and timezone specified.
abstract java.util.Date	parse(java.lang.String text) Returns parsed Date object from String.
abstract void	setTimeZone(java.util.TimeZone timezone) Sets time zone for this formatter.

Methods inherited from class java.lang.Object

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

Field Detail

DATE

public static final int DATE

Constant indicating date type.

See Also:

Constant Field Values

DATETIME

public static final int DATETIME

Constant indicating datetime type.

See Also:

Constant Field Values

TIME

public static final int TIME

Constant indicating time type.

See Also:

Constant Field Values

Constructor Detail

DateFormatter

public DateFormatter()

Method Detail

getInstance

public static DateFormatter getInstance(I18NContext context,
                                        int type)

Returns DateFormatter instance based on the type specified.

Parameters:

context - I18NContext, I18N context information for the current session.

type - int

           DATE
           DATETIME
           TIME
 

Returns:

DateFormatter

getInstance

public static DateFormatter getInstance(I18NContext context,
                                        int type,
                                        java.util.TimeZone timezone)

Returns DateFormatter instance based on the type and timezone specified.

Parameters:

context - I18NContext, I18N context information for the current session.

type - int

           DATE
           DATETIME
           TIME
 

timezone - TimeZone, Time zone for this formatter.

Returns:

DateFormatter

format

public abstract java.lang.String format(java.util.Date date)

Returns formatted date string based on the user preferences.

Parameters:

date - Date, date to be formatted.

Returns:

String, formatted date

parse

public abstract java.util.Date parse(java.lang.String text)

Returns parsed Date object from String. If the given string cannot be parsed as a date, null is returned.

Parameters:

text - String, to be parsed.

Returns:

Date parsed.

setTimeZone

public abstract void setTimeZone(java.util.TimeZone timezone)

Sets time zone for this formatter.

Parameters:

timezone - TimeZone for this formatter.