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(Calendar aCalendar) Formats a calendar according to the ISO8601 specification.
String	getCalendarAsString(String aFormatPattern, Calendar aCalendar) Formats the date of a Calendar according to a SimpleDateFormat pattern.
String	getCalendarAsString(String aFormatPattern, Calendar aCalendar, Locale aLocale) Formats the date of a Calendar according to a SimpleDateFormat pattern and a given Locale.
String	getDateAsISO8601String(Date aDate) Formats a date according to the ISO8601 specification.
String	getDateAsString(String aFormatPattern, Date aDate) Formats a Date according to a SimpleDateFormat pattern.
String	getDateAsString(String aFormatPattern, Date aDate, Locale aLocale) Formats a Date according to a SimpleDateFormat pattern using a given Locale.
String	getEditorFormatPattern(Locale aLocale) Gets the date format pattern used in the Sitevision editor for a specific Locale.
Date	parseDate(String aDateStr, String aFormatPattern) Converts a date string to a Date using a SimpleDateFormat pattern.
Date	parseDate(String aDateStr, String aFormatPattern, Locale aLocale) Converts a date string to a Date using a SimpleDateFormat pattern and a given Locale.
Calendar	toCalendar(Date aDate) Converts a Date to a Calendar.
Date	toDate(Calendar aCalendar) Converts a Calendar to a Date.

Method Detail

getDateAsISO8601String

String getDateAsISO8601String(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(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(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,
                       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. Default pattern will be used if aFormatPattern is null or blank

aDate - the Date

Returns:

returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate is null

See Also:

getDateAsString(String, Date, Locale)

getDateAsString

String getDateAsString(String aFormatPattern,
                       Date aDate,
                       Locale aLocale)

Formats a Date according to a SimpleDateFormat pattern using a given Locale.

Parameters:

aFormatPattern - date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank

aDate - the Date

aLocale - the Locale

Returns:

returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate or aLocale is null

Since:

Sitevision 8.2

getCalendarAsString

String getCalendarAsString(String aFormatPattern,
                           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. Default pattern will be used if aFormatPattern is null or blank

aCalendar - the Calendar

Returns:

returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar is null

See Also:

getCalendarAsString(String, Calendar, Locale)

getCalendarAsString

String getCalendarAsString(String aFormatPattern,
                           Calendar aCalendar,
                           Locale aLocale)

Formats the date of a Calendar according to a SimpleDateFormat pattern and a given Locale.

Parameters:

aFormatPattern - date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank

aCalendar - the Calendar

aLocale - the Locale

Returns:

returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar or aLocale is null

Since:

Sitevision 8.2

toCalendar

Calendar toCalendar(Date aDate)

Converts a Date to a Calendar.

Parameters:

aDate - a Date

Returns:

a Calendar representing aDate, or null if aDate is null

Since:

Sitevision 4.5.5

toDate

Date toDate(Calendar aCalendar)

Converts a Calendar to a Date.

Parameters:

aCalendar - a Calendar

Returns:

a Date representing aCalendar, or null if aCalendar is null

Since:

Sitevision 4.5.5

parseDate

Date parseDate(String aDateStr,
               String aFormatPattern)

Converts a date string to a Date using 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:

aDateStr - the string representation of a Date

aFormatPattern - string to date pattern according to SimpleDateFormat

Returns:

a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern) is null or blank

Since:

Sitevision 5.1

See Also:

parseDate(String, String, Locale)

parseDate

Date parseDate(String aDateStr,
               String aFormatPattern,
               Locale aLocale)

Converts a date string to a Date using a SimpleDateFormat pattern and a given Locale.

Parameters:

aDateStr - the string representation of a Date

aFormatPattern - string to date pattern according to SimpleDateFormat

aLocale - the Locale

Returns:

a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern, aLocale) is null or blank

Since:

Sitevision 8.2