biweekly.io

Class TimezoneAssignment

java.lang.Object

biweekly.io.TimezoneAssignment

public class TimezoneAssignment
extends Object

Represents a timezone definition that is used within an iCalendar object.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
TimezoneAssignment(TimeZone timezone, String globalId) Creates a timezone that will be inserted into the iCalendar object as a "global ID".
TimezoneAssignment(TimeZone timezone, VTimezone component) Creates a timezone that will be inserted into the iCalendar object as a VTIMEZONE component.

Method Summary

Modifier and Type	Method and Description
static TimezoneAssignment	download(TimeZone timezone, boolean outlookCompatible) Creates a timezone whose VTIMEZONE component is downloaded from tzurl.org.
VTimezone	getComponent() Gets the iCalendar component associated with the timezone.
String	getGlobalId() Gets the global ID associated with the timezone.
TimeZone	getTimeZone() Gets the Java object associated with the timezone.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimezoneAssignment

public TimezoneAssignment(TimeZone timezone,
                          VTimezone component)

Creates a timezone that will be inserted into the iCalendar object as a VTIMEZONE component. This what most iCalendar files use.

Parameters:

timezone - the Java timezone object

component - the iCalendar component

Throws:

IllegalArgumentException - if the given VTimezone component doesn't have a TimezoneId property

TimezoneAssignment

public TimezoneAssignment(TimeZone timezone,
                          String globalId)

Creates a timezone that will be inserted into the iCalendar object as a "global ID". This means that a VTimezone component containing the timezone definition will NOT be inserted into the iCalendar object.

Because the timezone definition is not included inside of the iCalendar object, the client consuming the iCalendar object must know how to interpret such an ID. The iCalendar specification does not specify a list of such IDs, but suggests using the naming convention of an existing timezone specification, such as the public-domain TZ database.

Parameters:

timezone - the Java timezone object

globalId - the global ID (e.g. "America/New_York")

Method Detail

download

public static TimezoneAssignment download(TimeZone timezone,
                                          boolean outlookCompatible)

Creates a timezone whose VTIMEZONE component is downloaded from tzurl.org.

Parameters:

timezone - the Java timezone object

outlookCompatible - true to download a VTimezone component that is tailored for Microsoft Outlook email clients, false to download a standards-based one.

Returns:

the timezone assignment

Throws:

IllegalArgumentException - if an appropriate VTIMEZONE component cannot be found on the website

getTimeZone

public TimeZone getTimeZone()

Gets the Java object associated with the timezone.

Returns:

the Java object

getComponent

public VTimezone getComponent()

Gets the iCalendar component associated with the timezone.

Returns:

the component or null if the timezone uses a global ID

getGlobalId

public String getGlobalId()

Gets the global ID associated with the timezone.

Returns:

the global ID or null if the timezone uses an iCalendar component