Package wt.util

Class WTStandardDateFormat

java.lang.Object

wt.util.WTStandardDateFormat

public class WTStandardDateFormat
extends Object

WTStandardDateFormat

This class provides methods to create display strings from Date objects. The methods may take as arguments, not only a Date, but also various combinations of format type, format string, Locale and TimeZone.

There are currently two standard formats defined: "long" and "short". "long" is the default format for methods which do not take a format argument. The format strings are in wt.util.utilResource.rbInfo.

Locale and TimeZone values default to those provided by WTContext methods.

Examples:

WTStandardDateFormat.format(myDate)

returns: "1998-05-28 14:22:35 CST"

WTStandardDateFormat.format(myDate, WTStandardDateFormat.SHORT_STANDARD_DATE_FORMAT)

returns: "98 May 28 14:22"

Supported API: true
Extendable: false

See Also:

• Date
• SimpleDateFormat

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXPLORER_STANDARD_DATE_FORMAT	Format for the default locale is 'M/dd/yy h:mm a'.
static final int	EXPLORER_STANDARD_DATE_ONLY_FORMAT	Format for the default locale is 'M/dd/yy'.
static final int	EXPLORER_STANDARD_TIME_ONLY_FORMAT	Format for the default locale is 'h:mm a'.
static final int	LONG_STANDARD_DATE_FORMAT	Format for the default locale is 'yyyy-MM-dd HH:mm:ss z'.
static final int	LONG_STANDARD_DATE_FORMAT_MINUS_TIME	Format for the default locale is 'yyyy-MM-dd'.
static final int	LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE	Format for the default locale is 'yyyy-MM-dd HH:mm:ss'.
static final int	SHORT_STANDARD_DATE_FORMAT	Format for the default locale is 'dd MMM yy HH:mm'.
static final int	WF_STANDARD_DATE_ONLY_FORMAT	Format for the default locale is 'MM/dd/yyyy'.

Constructor Summary

Constructors

Constructor	Description
WTStandardDateFormat()	No-arg constructor.

Method Summary

Modifier and Type	Method	Description
static String	format(Date date)	Formats a Date into a date/time string.
static String	format(Date date, int formatType)	Formats a Date into a date/time string.
static String	format(Date date, int formatType, Locale locale)	Formats a Date into a date/time string.
static String	format(Date date, int formatType, Locale locale, TimeZone timeZone)	Formats a Date into a date/time string.
static String	format(Date date, String formatString)	Formats a Date into a date/time string.
static String	format(Date date, String formatString, Locale locale, TimeZone timeZone)	Formats a Date into a date/time string.
static String	format(Date date, Locale locale)	Formats a Date into a date/time string.
static int	formatTypeFromString(String formatTypeString)	Converts the name of the format type to the constant that it represents.
static Date	parse(String date)	Parses text from a string in the format LONG_STANDARD_DATE_FORMAT to produce a Date.
static Date	parse(String date, int formatType)	Parses text from a string to produce a Date.
static Date	parse(String date, int formatType, Locale locale, TimeZone timeZone)	Parses text from a string to produce a Date.
static Date	parse(String date, String formatString)	Parses text from a string to produce a Date.
static Date	parse(String date, String formatString, Locale locale, TimeZone timeZone)	Parses text from a string to produce a Date.
static Date	parse(String date, Locale locale)	Parses text from a string in the format LONG_STANDARD_DATE_FORMAT to produce a Date.

Methods inherited from class java.lang.Object

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

Field Details

LONG_STANDARD_DATE_FORMAT

public static final int LONG_STANDARD_DATE_FORMAT

Format for the default locale is 'yyyy-MM-dd HH:mm:ss z'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

SHORT_STANDARD_DATE_FORMAT

public static final int SHORT_STANDARD_DATE_FORMAT

Format for the default locale is 'dd MMM yy HH:mm'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

EXPLORER_STANDARD_DATE_FORMAT

public static final int EXPLORER_STANDARD_DATE_FORMAT

Format for the default locale is 'M/dd/yy h:mm a'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

EXPLORER_STANDARD_DATE_ONLY_FORMAT

public static final int EXPLORER_STANDARD_DATE_ONLY_FORMAT

Format for the default locale is 'M/dd/yy'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

EXPLORER_STANDARD_TIME_ONLY_FORMAT

public static final int EXPLORER_STANDARD_TIME_ONLY_FORMAT

Format for the default locale is 'h:mm a'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

WF_STANDARD_DATE_ONLY_FORMAT

public static final int WF_STANDARD_DATE_ONLY_FORMAT

Format for the default locale is 'MM/dd/yyyy'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE

public static final int LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE

Format for the default locale is 'yyyy-MM-dd HH:mm:ss'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

LONG_STANDARD_DATE_FORMAT_MINUS_TIME

public static final int LONG_STANDARD_DATE_FORMAT_MINUS_TIME

Format for the default locale is 'yyyy-MM-dd'. This may vary with other locales.

Supported API: true
Extendable: false

See Also:

• Constant Field Values

Constructor Details

WTStandardDateFormat

public WTStandardDateFormat()

No-arg constructor.

Supported API: true

Method Details

formatTypeFromString

public static int formatTypeFromString(String formatTypeString)

Converts the name of the format type to the constant that it represents.

Parameters:

formatTypeString - The name of the format type. Valid values are:

• "LONG_STANDARD_DATE_FORMAT"
• "SHORT_STANDARD_DATE_FORMAT"
• "WF_STANDARD_DATE_ONLY_FORMAT"
• "EXPLORER_STANDARD_DATE_FORMAT"
• "EXPLORER_STANDARD_DATE_ONLY_FORMAT"
• "EXPLORER_STANDARD_TIME_ONLY_FORMAT"
• "LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE"
• "LONG_STANDARD_DATE_FORMAT_MINUS_TIME"

Returns:

The format type:

• LONG_STANDARD_DATE_FORMAT
• SHORT_STANDARD_DATE_FORMAT
• WF_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_DATE_FORMAT
• EXPLORER_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_TIME_ONLY_FORMAT
• LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE
• LONG_STANDARD_DATE_FORMAT_MINUS_TIME

Supported API: true
Extendable: false

format

public static String format(Date date,
 String formatString,
 Locale locale,
 TimeZone timeZone)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

formatString - The format string (see java.text.SimpleDateFormat).

locale - The locale.

timeZone - The given new time zone.

Returns:

The formatted date-time string.

Supported API: true
Extendable: false

format

public static String format(Date date,
 int formatType,
 Locale locale,
 TimeZone timeZone)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

formatType - The format. Valid values are:

• LONG_STANDARD_DATE_FORMAT
• SHORT_STANDARD_DATE_FORMAT
• WF_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_DATE_FORMAT
• EXPLORER_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_TIME_ONLY_FORMAT
• LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE
• LONG_STANDARD_DATE_FORMAT_MINUS_TIME

locale - The locale whose date format symbols should be used.

timeZone - The given new time zone.

Returns:

The formatted date-time string.

Supported API: true
Extendable: false

format

public static String format(Date date,
 String formatString)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

formatString - The format string (see java.text.SimpleDateFormat).

Returns:

The formatted date-time string.

Supported API: true
Extendable: false

format

public static String format(Date date,
 int formatType,
 Locale locale)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

formatType - The format. Valid values are:

• LONG_STANDARD_DATE_FORMAT
• SHORT_STANDARD_DATE_FORMAT
• WF_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_DATE_FORMAT
• EXPLORER_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_TIME_ONLY_FORMAT
• LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE
• LONG_STANDARD_DATE_FORMAT_MINUS_TIME

locale - The locale whose date format symbols should be used.

Returns:

The formatted date-time string.

Supported API: true
Extendable: false

format

public static String format(Date date,
 int formatType)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

formatType - The format. Valid values are:

• LONG_STANDARD_DATE_FORMAT
• SHORT_STANDARD_DATE_FORMAT
• WF_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_DATE_FORMAT
• EXPLORER_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_TIME_ONLY_FORMAT
• LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE
• LONG_STANDARD_DATE_FORMAT_MINUS_TIME

Returns:

The formatted date-time string.

Supported API: true
Extendable: false

format

public static String format(Date date,
 Locale locale)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

locale - The locale whose date format symbols should be used.

Returns:

The formatted date-time string in LONG_STANDARD_DATE_FORMAT format.

Supported API: true
Extendable: false

format

public static String format(Date date)

Formats a Date into a date/time string.

Parameters:

date - The date to be formatted into a String.

Returns:

The formatted date-time string in LONG_STANDARD_DATE_FORMAT format.

Supported API: true
Extendable: false

parse

public static Date parse(String date,
 String formatString,
 Locale locale,
 TimeZone timeZone)
                  throws ParseException

Parses text from a string to produce a Date.

Parameters:

date - The string to parse.

formatString - The format string (see java.text.SimpleDateFormat).

locale - The locale.

timeZone - The time zone to use in parsing.

Returns:

A Date parsed from the string. In case of error, returns null.

Throws:

ParseException -

Supported API: true
Extendable: false

parse

public static Date parse(String date,
 int formatType,
 Locale locale,
 TimeZone timeZone)
                  throws ParseException

Parses text from a string to produce a Date.

Parameters:

date - The string to parse.

formatType - The format. Valid values are:

• LONG_STANDARD_DATE_FORMAT
• SHORT_STANDARD_DATE_FORMAT
• WF_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_DATE_FORMAT
• EXPLORER_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_TIME_ONLY_FORMAT
• LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE
• LONG_STANDARD_DATE_FORMAT_MINUS_TIME

locale - The locale.

timeZone - The time zone to use in parsing.

Returns:

A Date parsed from the string. In case of error, returns null.

Throws:

ParseException -

Supported API: true
Extendable: false

parse

public static Date parse(String date,
 String formatString)
                  throws ParseException

Parses text from a string to produce a Date.

Parameters:

date - The string to parse.

formatString - The format string (see java.text.SimpleDateFormat).

Returns:

A Date parsed from the string. In case of error, returns null.

Throws:

ParseException -

Supported API: true
Extendable: false

parse

public static Date parse(String date,
 int formatType)
                  throws ParseException

Parses text from a string to produce a Date.

Parameters:

date - The string to parse.

formatType - The format. Valid values are:

• LONG_STANDARD_DATE_FORMAT
• SHORT_STANDARD_DATE_FORMAT
• WF_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_DATE_FORMAT
• EXPLORER_STANDARD_DATE_ONLY_FORMAT
• EXPLORER_STANDARD_TIME_ONLY_FORMAT
• LONG_STANDARD_DATE_FORMAT_MINUS_TIMEZONE
• LONG_STANDARD_DATE_FORMAT_MINUS_TIME

Returns:

A Date parsed from the string. In case of error, returns null.

Throws:

ParseException -

Supported API: true
Extendable: false

parse

public static Date parse(String date,
 Locale locale)
                  throws ParseException

Parses text from a string in the format LONG_STANDARD_DATE_FORMAT to produce a Date.

Parameters:

date - The string to parse.

locale - The locale.

Returns:

A Date parsed from the string. In case of error, returns null.

Throws:

ParseException -

Supported API: true
Extendable: false

parse

public static Date parse(String date)
                  throws ParseException

Parses text from a string in the format LONG_STANDARD_DATE_FORMAT to produce a Date.

Parameters:

date - The string to parse.

Returns:

A Date parsed from the string. In case of error, returns null.

Throws:

ParseException -

Supported API: true
Extendable: false