senselogic.sitevision.api.date

Interface DateUtil

@Requireable(value="DateUtil")
public interface DateUtil

Date utility interface.

An instance of the SiteVision class implementing this interface can be obtained via Utils.getDateUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

SiteVision 3.5

Author:

Albin Öhrn

Method Summary

Modifier and Type	Method and Description
String	getCalendarAsISO8601String(java.util.Calendar aCalendar) Formats a calendar according to the ISO8601 specification.
String	getCalendarAsString(String aFormatPattern, java.util.Calendar aCalendar) Formats the date of a calendar according to a SimpleDateFormat pattern.
String	getDateAsISO8601String(java.util.Date aDate) Formats a date according to the ISO8601 specification.
String	getDateAsString(String aFormatPattern, java.util.Date aDate) Formats a date according to a SimpleDateFormat pattern.
String	getEditorFormatPattern(java.util.Locale aLocale) Gets the date format pattern used in the SiteVision editor for a specific Locale.

Method Detail

getDateAsISO8601String

String getDateAsISO8601String(java.util.Date aDate)

Formats a date according to the ISO8601 specification.

An example: A date representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be ISO8601 formatted as 2001-02-03T04:05+01:00.

Parameters:

aDate - a Date that needs to be formatted

Returns:

the date formatted as a ISO8601 string, or null if aDate is null

getCalendarAsISO8601String

String getCalendarAsISO8601String(java.util.Calendar aCalendar)

Formats a calendar according to the ISO8601 specification.

An example: A calendar representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be ISO8601 formatted as 2001-02-03T04:05+01:00.

Parameters:

aCalendar - a Calendar that needs to be formatted

Returns:

aString the calendar date formatted as a ISO8601 string, or null if aCalendar is null

getEditorFormatPattern

String getEditorFormatPattern(java.util.Locale aLocale)

Gets the date format pattern used in the SiteVision editor for a specific Locale.

Parameters:

aLocale - the Locale that specifies the date format pattern

Returns:

the date format pattern used in the SiteVision editor that corresponds to aLocale. If aLocale is null then the current locale (as of PortletContextUtil.getCurrentLocale()) is used to locate the format pattern. If no pattern exist for aLocale then the pattern that corresponds to Locale.ENGLISH will be returned.

getDateAsString

String getDateAsString(String aFormatPattern,
                       java.util.Date aDate)

Formats a date according to a SimpleDateFormat pattern.

Note! The current locale as of PortletContextUtil.getCurrentLocale() will be used. If current locale is unavailable, Locale.getDefault() will be used.

Parameters:

aFormatPattern - date to string pattern according to SimpleDateFormat. If null, default format is used

aDate - the Date

Returns:

returns a String representation of aDate according to aFormatPattern. Returns null if aDate is null.

getCalendarAsString

String getCalendarAsString(String aFormatPattern,
                           java.util.Calendar aCalendar)

Formats the date of a calendar according to a SimpleDateFormat pattern.

Note! The current locale as of PortletContextUtil.getCurrentLocale() will be used. If current locale is unavailable, Locale.getDefault() will be used.

Parameters:

aFormatPattern - date to string pattern according to SimpleDateFormat. If null, default format is used

aCalendar - the Calendar

Returns:

returns a String representation of the date of aCalendar according to aFormatPattern. Returns null if aDate is null.