com.day.cq.collab.calendar

Class CalendarUtil

java.lang.Object

com.day.cq.collab.calendar.CalendarUtil

Deprecated.

@Deprecated
public abstract class CalendarUtil
extends java.lang.Object

Utility class for calendar and date conversions, time zone handling, etc.

Since:

5.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ECMA_DATE_ONLY_PATTERN Deprecated. The SimpleDateFormat-style pattern for the Javascript / ECMA date format string when only a pure date without time is to be transferred.
static java.lang.String	ECMA_DATE_PATTERN Deprecated. The SimpleDateFormat-style pattern for the Javascript / ECMA date format string.
static java.util.TimeZone	UTC Deprecated. Represents the "Etc/UTC" timezone with no offset at all.
static java.lang.String	UTC_ID Deprecated. Standard Olson timezone database ID for the UTC timezone.

Constructor Summary

Constructors

Constructor and Description
CalendarUtil() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	calendarToString(java.util.Calendar cal) Deprecated. Safely prints a Calendar object for debugging output.
static java.text.SimpleDateFormat	getEcmaDateFormat(boolean isDate, java.lang.String timeZoneID) Deprecated. Returns a new SimpleDateFormat that parses and formats date strings for use with Javascript (ECMA Script) in browsers.
static java.util.TimeZone	getTimeZone(java.lang.String tzID) Deprecated. Returns a timezone by it's Olson timezone database ID, using the internal timezone registry instead of the built-in Java timezones TimeZone.getTimeZone(String).
static java.util.Calendar	replaceTimeZone(java.util.Calendar cal, java.util.TimeZone timeZone) Deprecated. Returns a new calendar that has exactly the same date and time parts as the given original calendar, but with the new timezone.
static java.util.Calendar	shiftTimeZone(java.util.Calendar cal, java.util.TimeZone timeZone) Deprecated. Shifts a calendar into the given timezone.
static java.util.Calendar	shiftToUTC(java.util.Calendar cal) Deprecated. Shifts the calendar into the UTC timezone (no timezone offset).

Methods inherited from class java.lang.Object

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

Field Detail

UTC

public static final java.util.TimeZone UTC

Deprecated.

Represents the "Etc/UTC" timezone with no offset at all.

UTC_ID

public static final java.lang.String UTC_ID

Deprecated.

Standard Olson timezone database ID for the UTC timezone.

ECMA_DATE_PATTERN

public static final java.lang.String ECMA_DATE_PATTERN

Deprecated.

The SimpleDateFormat-style pattern for the Javascript / ECMA date format string.

Note that this is the variant without commata after weekday and after the date, which seems to be more common.

See Also:

Constant Field Values

ECMA_DATE_ONLY_PATTERN

public static final java.lang.String ECMA_DATE_ONLY_PATTERN

Deprecated.

The SimpleDateFormat-style pattern for the Javascript / ECMA date format string when only a pure date without time is to be transferred.

See Also:

Constant Field Values

Constructor Detail

CalendarUtil

public CalendarUtil()

Deprecated.

Method Detail

getEcmaDateFormat

public static java.text.SimpleDateFormat getEcmaDateFormat(boolean isDate,
                                           java.lang.String timeZoneID)

Deprecated.

Returns a new SimpleDateFormat that parses and formats date strings for use with Javascript (ECMA Script) in browsers. The output can be used in new Date(string) in Javascript. An example ECMA date string is: Wed Aug 27 2008 23:59:59 GMT+0200.

When isDate == true, the format will only print the date part and not include the time and timezone parts. For example: Wed Aug 27 2008.

The timeZoneID can be optionally given to denote the timezone in which the string should be formatted. For example, an UTC date such as Wed Aug 27 2008 10:00:00 GMT+0000 will result in:

• Wed Aug 27 2008 05:00:00 GMT-0500 for a timezone with -5h offset, eg. "America/New_York"
• Wed Aug 27 2008 11:00:00 GMT+0100 for a timezone with +1h offset, eg. "Europe/Berlin"

If timeZoneID == null, the UTC timezone will be used. When isDate == true, it will be ignored.

The locale used will always be US as that seems to be the string format that all browsers can parse with new Date(string). The patterns used are ECMA_DATE_PATTERN and ECMA_DATE_ONLY_PATTERN (when isDate == true).

Parameters:

isDate - whether only the date part should be formatted

timeZoneID - a time zone ID such as "Europe/Berlin" (optional, can be null, in which case UTC is used; ignored when isDate == true)

Returns:

a SimpleDateFormat for the ECMA date format

getTimeZone

public static java.util.TimeZone getTimeZone(java.lang.String tzID)

Deprecated.

Returns a timezone by it's Olson timezone database ID, using the internal timezone registry instead of the built-in Java timezones TimeZone.getTimeZone(String).

Parameters:

tzID - timezone ID, eg. "Europe/Berlin"

Returns:

a TimeZone object or null if the id was not found or was null

shiftTimeZone

public static java.util.Calendar shiftTimeZone(java.util.Calendar cal,
                               java.util.TimeZone timeZone)

Deprecated.

Shifts a calendar into the given timezone. This keeps the same UTC millis, but changes the representation to be in the other timezone. This is a safe replacement for using Calendar.setTimeZone(TimeZone).

For example, a date like 2009-08-10 12:00 +02:00 with a target timezone -02:00 would result in 2009-08-10 08:00 -02:00.

Parameters:

cal - input date in another timezone

timeZone - target timezone

Returns:

a new calendar object with the given date shifted into the given timezone

shiftToUTC

public static java.util.Calendar shiftToUTC(java.util.Calendar cal)

Deprecated.

Shifts the calendar into the UTC timezone (no timezone offset). This is the same as calling shiftTimeZone(Calendar, TimeZone) with the "Etc/UTC" timezone.

For example, a date like 2009-08-10 12:00 +02:00 would result in 2009-08-10 10:00 +00:00.

Parameters:

cal - input date in another timezone

Returns:

a new calendar object with the given date shifted into the UTC timezone

replaceTimeZone

public static java.util.Calendar replaceTimeZone(java.util.Calendar cal,
                                 java.util.TimeZone timeZone)

Deprecated.

Returns a new calendar that has exactly the same date and time parts as the given original calendar, but with the new timezone. This will not adjust the time like shiftTimeZone(Calendar, TimeZone) or Calendar.setTimeZone(java.util.TimeZone) would do, but instead replaces it. This keeps the date and time parts the same, and effectively changes the UTC millis.

For example, a date like 2009-08-10 12:00 +02:00 with a target timezone -02:00 would result in 2009-08-10 12:00 -02:00.

Parameters:

cal - input date

timeZone - target timezone

Returns:

a new calendar object in the target timezone and the same date and time fields as the original calendar object

calendarToString

public static java.lang.String calendarToString(java.util.Calendar cal)

Deprecated.

Safely prints a Calendar object for debugging output. Shows only the important fields and is much more readable than the standard Calendar.toString() output.