com.google.gwt.i18n.client
Class DateTimeFormat

java.lang.Object
  com.google.gwt.i18n.client.DateTimeFormat

public class DateTimeFormat
extends java.lang.Object

Formats and parses dates and times using locale-sensitive patterns.

Patterns

The number of pattern letters influences the format, as follows:

Text

if 4 or more, then use the full form; if less than 4, use short or abbreviated form if it exists (e.g., "EEEE" produces "Monday", "EEE" produces "Mon")

Number

the minimum number of digits. Shorter numbers are zero-padded to this amount (e.g. if "m" produces "6", "mm" produces "06"). Year is handled specially; that is, if the count of 'y' is 2, the Year will be truncated to 2 digits. (e.g., if "yyyy" produces "1997", "yy" produces "97".) Unlike other fields, fractional seconds are padded on the right with zero.

Text or Number

3 or more, use text, otherwise use number. (e.g. "M" produces "1", "MM" produces "01", "MMM" produces "Jan", and "MMMM" produces "January". Some pattern letters also treat a count of 5 specially, meaning a single-letter abbreviation: L, M, E, and c.

Any characters in the pattern that are not in the ranges of ['a '..'z'] and ['A'..'Z'] will be treated as quoted text. For instance, characters like ':', ' .', ' ' (space), '#' and ' @' will appear in the resulting time text even they are not embraced within single quotes.

[Time Zone Handling] Web browsers don't provide all the information we need for proper time zone formating -- so GWT has a copy of the required data, for your convenience. For simpler cases, one can also use a fallback implementation that only keeps track of the current timezone offset. These two approaches are called, respectively, Common TimeZones and Simple TimeZones, although both are implemented with the same TimeZone class. "TimeZone createTimeZone(String timezoneData)" returns a Common TimeZone object, and "TimeZone createTimeZone(int timeZoneOffsetInMinutes)" returns a Simple TimeZone object. The one provided by OS fall into to Simple TimeZone category. For formatting purpose, following table shows the behavior of GWT DateTimeFormat.

Parsing Dates and Times

The pattern does not need to specify every field. If the year, month, or day is missing from the pattern, the corresponding value will be taken from the current date. If the month is specified but the day is not, the day will be constrained to the last day within the specified month. If the hour, minute, or second is missing, the value defaults to zero.

As with formatting (described above), the count of pattern letters determines the parsing behavior.

Text

4 or more pattern letters--use full form, less than 4--use short or abbreviated form if one exists. In parsing, we will always try long format, then short.

Number

the minimum number of digits.

Text or Number

3 or more characters means use text, otherwise use number

Although the current pattern specification doesn't not specify behavior for all letters, it may in the future. It is strongly discouraged to use unspecified letters as literal text without quoting them.

[Note on TimeZone] The time zone support for parsing is limited. Only standard GMT and RFC format are supported. Time zone specification using time zone id (like America/Los_Angeles), time zone names (like PST, Pacific Standard Time) are not supported. Normally, it is too much a burden for a client application to load all the time zone symbols. And in almost all those cases, it is a better choice to do such parsing on server side through certain RPC mechanism. This decision is based on particular use cases we have studied; in principle, it could be changed in future versions.

Examples

Additional Parsing Considerations

When parsing a date string using the abbreviated year pattern ( "yy"), the parser must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the parser instance is created. For example, using a pattern of "MM/dd/yy" and a DateTimeFormat object created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, as defined by Character.isDigit(char), will be parsed into the default century. If the year pattern does not have exactly two 'y' characters, the year is interpreted literally, regardless of the number of digits. For example, using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.

When numeric fields abut one another directly, with no intervening delimiter characters, they constitute a run of abutting numeric fields. Such runs are parsed specially. For example, the format "HHmmss" parses the input text "123456" to 12:34:56, parses the input text "12345" to 1:23:45, and fails to parse "1234". In other words, the leftmost field of the run is flexible, while the others keep a fixed width. If the parse fails anywhere in the run, then the leftmost field is shortened by one character, and the entire run is parsed again. This is repeated until either the parse succeeds or the leftmost field is one character in length. If the parse still fails at that point, the parse of the run fails.

In the current implementation, timezone parsing only supports GMT:hhmm, GMT:+hhmm, and GMT:-hhmm.

Example

public class DateTimeFormatExample implements EntryPoint {

  public void onModuleLoad() {
    Date today = new Date();

    // prints Tue Dec 18 12:01:26 GMT-500 2007 in the default locale.
    GWT.log(today.toString());

    // prints 12/18/07 in the default locale
    GWT.log(DateTimeFormat.getShortDateFormat().format(today));

    // prints December 18, 2007 in the default locale
    GWT.log(DateTimeFormat.getLongDateFormat().format(today));

    // prints 12:01 PM in the default locale
    GWT.log(DateTimeFormat.getShortTimeFormat().format(today));

    // prints 12:01:26 PM GMT-05:00 in the default locale
    GWT.log(DateTimeFormat.getLongTimeFormat().format(today));

    // prints Dec 18, 2007 12:01:26 PM in the default locale
    GWT.log(DateTimeFormat.getMediumDateTimeFormat().format(today));
    
    // A custom date format
    DateTimeFormat fmt = DateTimeFormat.getFormat("EEEE, MMMM dd, yyyy");
    // prints Monday, December 17, 2007 in the default locale
    GWT.log(fmt.format(today));
  }
}

DateTimeFormat

protected DateTimeFormat(java.lang.String pattern)

Constructs a format object using the specified pattern and the date time constants for the default locale.

Parameters:

pattern - string pattern specification

DateTimeFormat

@Deprecated
protected DateTimeFormat(java.lang.String pattern,
                                    DateTimeConstants dateTimeConstants)

Deprecated. use DateTimeFormat(String, DateTimeFormatInfo)

Constructs a format object using the specified pattern and user-supplied date time constants.

Parameters:

pattern - string pattern specification

dateTimeConstants - locale specific symbol collection

DateTimeFormat

protected DateTimeFormat(java.lang.String pattern,
                         DateTimeFormatInfo dtfi)

Constructs a format object using the specified pattern and user-supplied date time constants.

Parameters:

pattern - string pattern specification

dtfi - DateTimeFormatInfo instance to use

getFormat

public static DateTimeFormat getFormat(DateTimeFormat.PredefinedFormat predef)

Get a DateTimeFormat instance for a predefined format.

See CustomDateTimeFormat if you need a localized format that is not supported here.

Parameters:

predef - DateTimeFormat.PredefinedFormat describing desired format

Returns:

a DateTimeFormat instance for the specified format

getFormat

public static DateTimeFormat getFormat(java.lang.String pattern)

Returns a DateTimeFormat object using the specified pattern. If you need to format or parse repeatedly using the same pattern, it is highly recommended that you cache the returned DateTimeFormat object and reuse it rather than calling this method repeatedly.

Note that the pattern supplied is used as-is -- for example, if you supply "MM/dd/yyyy" as the pattern, that is the order you will get the fields, even in locales where the order is different. It is recommended to use getFormat(PredefinedFormat) instead -- if you use this method, you are taking responsibility for localizing the patterns yourself.

Parameters:

pattern - string to specify how the date should be formatted

Returns:

a DateTimeFormat object that can be used for format or parse date/time values matching the specified pattern

Throws:

java.lang.IllegalArgumentException - if the specified pattern could not be parsed

getFullDateFormat

@Deprecated
public static DateTimeFormat getFullDateFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_FULL instead

Retrieve the DateTimeFormat object for full date format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getFullDateTimeFormat

@Deprecated
public static DateTimeFormat getFullDateTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_TIME_FULL instead

Retrieve the DateTimeFormat object for full date and time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getFullTimeFormat

@Deprecated
public static DateTimeFormat getFullTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.TIME_FULL instead

Retrieve the DateTimeFormat object for full time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getLongDateFormat

@Deprecated
public static DateTimeFormat getLongDateFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_LONG instead

Retrieve the DateTimeFormat object for long date format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getLongDateTimeFormat

@Deprecated
public static DateTimeFormat getLongDateTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_TIME_LONG instead

Retrieve the DateTimeFormat object for long date and time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getLongTimeFormat

@Deprecated
public static DateTimeFormat getLongTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.TIME_LONG instead

Retrieve the DateTimeFormat object for long time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getMediumDateFormat

@Deprecated
public static DateTimeFormat getMediumDateFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_MEDIUM instead

Retrieve the DateTimeFormat object for medium date format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getMediumDateTimeFormat

@Deprecated
public static DateTimeFormat getMediumDateTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_TIME_MEDIUM instead

Retrieve the DateTimeFormat object for medium date and time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getMediumTimeFormat

@Deprecated
public static DateTimeFormat getMediumTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.TIME_MEDIUM instead

Retrieve the DateTimeFormat object for medium time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getShortDateFormat

@Deprecated
public static DateTimeFormat getShortDateFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_SHORT instead

Retrieve the DateTimeFormat object for short date format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getShortDateTimeFormat

@Deprecated
public static DateTimeFormat getShortDateTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.DATE_TIME_SHORT instead

Retrieve the DateTimeFormat object for short date and time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object

getShortTimeFormat

@Deprecated
public static DateTimeFormat getShortTimeFormat()

Deprecated. use getFormat(PredefinedFormat) with DateTimeFormat.PredefinedFormat.TIME_SHORT instead

Retrieve the DateTimeFormat object for short time format. The pattern for this format is predefined for each locale.

Returns:

A DateTimeFormat object.

getFormat

protected static DateTimeFormat getFormat(java.lang.String pattern,
                                          DateTimeFormatInfo dtfi)

Internal factory method that provides caching.

Parameters:

pattern -

dtfi -

Returns:

DateTimeFormat instance

format

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

Format a date object.

Parameters:

date - the date object being formatted

Returns:

string representation for this date in desired format

format

public java.lang.String format(java.util.Date date,
                               TimeZone timeZone)

Format a date object using specified time zone.

Parameters:

date - the date object being formatted

timeZone - a TimeZone object that holds time zone information

Returns:

string representation for this date in the format defined by this object

getPattern

public java.lang.String getPattern()

Retrieve the pattern used in this DateTimeFormat object.

Returns:

pattern string

parse

public java.util.Date parse(java.lang.String text)
                     throws java.lang.IllegalArgumentException

Parses text to produce a Date value. An IllegalArgumentException is thrown if either the text is empty or if the parse does not consume all characters of the text. Dates are parsed leniently, so invalid dates will be wrapped around as needed. For example, February 30 will wrap to March 2.

Parameters:

text - the string being parsed

Returns:

a parsed date/time value

Throws:

java.lang.IllegalArgumentException - if the entire text could not be converted into a number

parse

public int parse(java.lang.String text,
                 int start,
                 java.util.Date date)

This method modifies a Date object to reflect the date that is parsed from an input string. Dates are parsed leniently, so invalid dates will be wrapped around as needed. For example, February 30 will wrap to March 2.

Parameters:

text - the string that need to be parsed

start - the character position in "text" where parsing should start

date - the date object that will hold parsed value

Returns:

0 if parsing failed, otherwise the number of characters advanced

parseStrict

public java.util.Date parseStrict(java.lang.String text)
                           throws java.lang.IllegalArgumentException

Parses text to produce a Date value. An IllegalArgumentException is thrown if either the text is empty or if the parse does not consume all characters of the text. Dates are parsed strictly, so invalid dates will result in an IllegalArgumentException.

Parameters:

text - the string being parsed

Returns:

a parsed date/time value

Throws:

java.lang.IllegalArgumentException - if the entire text could not be converted into a number

parseStrict

public int parseStrict(java.lang.String text,
                       int start,
                       java.util.Date date)

This method modifies a Date object to reflect the date that is parsed from an input string. Dates are parsed strictly, so invalid dates will return 0. For example, February 30 will return 0 because February only has 28 days.

Parameters:

text - the string that need to be parsed

start - the character position in "text" where parsing should start

date - the date object that will hold parsed value

Returns:

0 if parsing failed, otherwise the number of characters advanced