org.omnifaces.el.functions

Class Dates

java.lang.Object

org.omnifaces.el.functions.Dates

public final class Dates
extends Object

Collection of EL functions for date and time.

Author:

Bauke Scholtz

Method Summary

Methods

Modifier and Type	Method and Description
static String	formatDate(Date date, String pattern) Format the given date in the given pattern with system default timezone.
static String	formatDateWithTimezone(Date date, String pattern, String timezone) Format the given date in the given pattern with the given timezone.
static Map<String,Integer>	getMonths() Returns a mapping of month names by month numbers for the current locale.
static Map<String,Integer>	getShortMonths() Returns a mapping of short month names by month numbers for the current locale.

Methods inherited from class java.lang.Object

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

Method Detail

formatDate

public static String formatDate(Date date,
                String pattern)

Format the given date in the given pattern with system default timezone. This is useful when you want to format dates in for example the title attribute of an UI component, or the itemLabel attribute of select item, or wherever you can't use the <f:convertDateTime> tag. The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

date - The date to be formatted in the given pattern.

pattern - The pattern to format the given date in.

Returns:

The date which is formatted in the given pattern.

Throws:

NullPointerException - When the pattern is null.

See Also:

formatDateWithTimezone(Date, String, String)

formatDateWithTimezone

public static String formatDateWithTimezone(Date date,
                            String pattern,
                            String timezone)

Format the given date in the given pattern with the given timezone. This is useful when you want to format dates in for example the title attribute of an UI component, or the itemLabel attribute of select item, or wherever you can't use the <f:convertDateTime> tag. The format locale will be set to the one as obtained by Faces.getLocale().

Parameters:

date - The date to be formatted in the given pattern.

pattern - The pattern to format the given date in.

timezone - The timezone to format the given date with.

Returns:

The date which is formatted in the given pattern.

Throws:

NullPointerException - When the pattern is null.

getMonths

public static Map<String,Integer> getMonths()

Returns a mapping of month names by month numbers for the current locale. For example: "January=1", "February=2", etc. This is useful if you want to for example populate a <f:selectItems> which shows all months. The locale is obtained by Faces.getLocale(). The mapping is per locale stored in a local cache to improve retrieving performance.

Returns:

Month names for the current locale.

See Also:

DateFormatSymbols.getMonths()

getShortMonths

public static Map<String,Integer> getShortMonths()

Returns a mapping of short month names by month numbers for the current locale. For example: "Jan=1", "Feb=2", etc. This is useful if you want to for example populate a <f:selectItems> which shows all short months. The locale is obtained by Faces.getLocale(). The mapping is per locale stored in a local cache to improve retrieving performance.

Returns:

Short month names for the current locale.

See Also:

DateFormatSymbols.getShortMonths()