ilog.views.util.text

Class IlvDateFormatFactory

java.lang.Object

ilog.views.util.text.IlvDateFormatFactory

public final class IlvDateFormatFactory
extends Object

The IlvDateFormatFactory class provides static factory methods that can be used to create date format instances. The method signatures are consistent with those provided by the standard DateFormat class and the date formatters returned are compatible. However, using the methods of this class provides several advantages over using the standard DateFormat:

• IlvDateFormatFactory returns instances of IlvDateFormat, instead of instances of SimpleDateFormat. It automatically uses an ICU SimpleDateFormat instead of a java.text.SimpleDateFormat if appropriate. Also, if the FastDateFormat class from the Jakarta Commons Lang package is available on the classpath, IlvDateFormat automatically takes advantage of this to provide much faster formatted output.
• IlvDateFormatFactory implements caching techniques to provide a significant speed improvement when creating date format instances.

Since:

JViews 7.5

See Also:

IlvDateFormat

Method Summary

Modifier and Type	Method and Description
static DateFormat	getDateInstance() Returns a date formatter with the default formatting style in the current locale.
static DateFormat	getDateInstance(int dateStyle) Returns a date formatter with the given DateFormat style in the current locale.
static DateFormat	getDateInstance(int dateStyle, ULocale locale) Returns a date formatter with the given DateFormat style for the given locale.
static DateFormat	getDateTimeInstance() Returns a date/time formatter with the default formatting style in the current locale and default timezone.
static DateFormat	getDateTimeInstance(int dateStyle, int timeStyle) Returns a date/time formatter with the given date and time DateFormat styles in the current locale and default timezone.
static DateFormat	getDateTimeInstance(int dateStyle, int timeStyle, ULocale locale) Returns a date/time formatter with the given date and time DateFormat styles for the given locale, in the default timezone.
static DateFormat	getDateTimeInstance(int dateStyle, int timeStyle, ULocale locale, TimeZone timeZone) Returns a date/time formatter with the given date and time DateFormat styles for the given locale and timezone.
static DateFormat	getInstance() Returns a default date/time formatter that uses the DateFormat.SHORT style for both the date and the time in the current locale and default timezone.
static DateFormat	getInstance(String pattern) Returns a date/time formatter instance using the specified pattern in the current locale and default timezone.
static DateFormat	getInstance(String pattern, ULocale locale, TimeZone timeZone) Returns a date/time formatter instance using the specified pattern for the given locale and timezone.
static DateFormat	getInstance(ULocale locale) Returns a default date/time formatter that uses the DateFormat.SHORT style for both the date and the time in the given locale and default timezone.
static DateFormat	getTimeInstance() Returns a time formatter with the default formatting style in the current locale and default timezone.
static DateFormat	getTimeInstance(int timeStyle) Returns a time formatter with the given time DateFormat style in the current locale and default timezone.
static DateFormat	getTimeInstance(int timeStyle, ULocale locale) Returns a time formatter with the given time DateFormat style for the given locale, in the default timezone.
static DateFormat	getTimeInstance(int timeStyle, ULocale locale, TimeZone timeZone) Returns a time formatter with the given time DateFormat style for the given locale and timezone.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DateFormat getInstance()

Returns a default date/time formatter that uses the DateFormat.SHORT style for both the date and the time in the current locale and default timezone.

Returns:

A default date/time formatter.

getInstance

public static DateFormat getInstance(ULocale locale)

Returns a default date/time formatter that uses the DateFormat.SHORT style for both the date and the time in the given locale and default timezone.

Returns:

A default date/time formatter.

Since:

JViews 8.8

getInstance

public static DateFormat getInstance(String pattern)

Returns a date/time formatter instance using the specified pattern in the current locale and default timezone.

Parameters:

pattern - A SimpleDateFormat compatible pattern.

Returns:

A pattern based date/time formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

getInstance

public static DateFormat getInstance(String pattern,
                                     ULocale locale,
                                     TimeZone timeZone)

Returns a date/time formatter instance using the specified pattern for the given locale and timezone.

Parameters:

pattern - A SimpleDateFormat compatible pattern.

locale - The locale or null for the current locale.

timeZone - The timezone or null for the default timezone.

Returns:

A pattern based date/time formatter

Throws:

IllegalArgumentException - if the pattern is invalid.

Since:

JViews 8.8

getDateInstance

public static DateFormat getDateInstance()

Returns a date formatter with the default formatting style in the current locale.

Returns:

A default date formatter.

getDateInstance

public static DateFormat getDateInstance(int dateStyle)

Returns a date formatter with the given DateFormat style in the current locale.

Parameters:

dateStyle - The DateFormat style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.

Returns:

A date formatter.

getDateInstance

public static DateFormat getDateInstance(int dateStyle,
                                         ULocale locale)

Returns a date formatter with the given DateFormat style for the given locale.

Parameters:

dateStyle - The DateFormat style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.

locale - The locale or null for the current locale.

Returns:

A date formatter.

Since:

JViews 8.8

getTimeInstance

public static DateFormat getTimeInstance()

Returns a time formatter with the default formatting style in the current locale and default timezone.

Returns:

A default time formatter.

getTimeInstance

public static DateFormat getTimeInstance(int timeStyle)

Returns a time formatter with the given time DateFormat style in the current locale and default timezone.

Parameters:

timeStyle - The time DateFormat style. For example, DateFormat.SHORT for "h:mm a" in the US locale.

Returns:

A time formatter.

getTimeInstance

public static DateFormat getTimeInstance(int timeStyle,
                                         ULocale locale)

Returns a time formatter with the given time DateFormat style for the given locale, in the default timezone.

Parameters:

timeStyle - The time DateFormat style. For example, DateFormat.SHORT for "h:mm a" in the US locale.

locale - The locale or null for the current locale.

Returns:

A time formatter.

Since:

JViews 8.8

getTimeInstance

public static DateFormat getTimeInstance(int timeStyle,
                                         ULocale locale,
                                         TimeZone timeZone)

Returns a time formatter with the given time DateFormat style for the given locale and timezone.

Parameters:

timeStyle - The time DateFormat style. For example, DateFormat.SHORT for "h:mm a" in the US locale.

locale - The locale or null for the current locale.

timeZone - The timezone or null for the default timezone.

Returns:

A time formatter.

Since:

JViews 8.8

getDateTimeInstance

public static DateFormat getDateTimeInstance()

Returns a date/time formatter with the default formatting style in the current locale and default timezone.

Returns:

A default date/time formatter.

getDateTimeInstance

public static DateFormat getDateTimeInstance(int dateStyle,
                                             int timeStyle)

Returns a date/time formatter with the given date and time DateFormat styles in the current locale and default timezone.

Parameters:

dateStyle - The date DateFormat style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.

timeStyle - The time DateFormat style. For example, DateFormat.SHORT for "h:mm a" in the US locale.

Returns:

A date/time formatter.

getDateTimeInstance

public static DateFormat getDateTimeInstance(int dateStyle,
                                             int timeStyle,
                                             ULocale locale)

Returns a date/time formatter with the given date and time DateFormat styles for the given locale, in the default timezone.

Parameters:

dateStyle - The date DateFormat style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.

timeStyle - The time DateFormat style. For example, DateFormat.SHORT for "h:mm a" in the US locale.

locale - The locale or null for the current locale.

Returns:

A date/time formatter.

Since:

JViews 8.8

getDateTimeInstance

public static DateFormat getDateTimeInstance(int dateStyle,
                                             int timeStyle,
                                             ULocale locale,
                                             TimeZone timeZone)

Returns a date/time formatter with the given date and time DateFormat styles for the given locale and timezone.

Parameters:

dateStyle - The date DateFormat style. For example, DateFormat.SHORT for "M/d/yy" in the US locale.

timeStyle - The time DateFormat style. For example, DateFormat.SHORT for "h:mm a" in the US locale.

locale - The locale or null for the current locale.

timeZone - The timezone or null for the default timezone.

Returns:

A date/time formatter.

Since:

JViews 8.8