biweekly.io

Class TimezoneInfo

java.lang.Object

biweekly.io.TimezoneInfo

public class TimezoneInfo
extends Object

Holds the timezone-related settings of an iCalendar object.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
TimezoneInfo()

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(VTimezone component, TimeZone timezone) Assigns a user-defined VTimezone component to its Java TimeZone equivalent.
VTimezone	getComponent(ICalProperty property) Gets the VTimezone component that a property is assigned to.
Collection<VTimezone>	getComponents() Gets all of the iCalendar VTimezone components that have been registered or generated by this class.
VTimezoneGenerator	getGenerator() Gets the timezone generator.
TimeZone	getTimeZone(ICalProperty property) Gets the timezone that is assigned to a property.
TimeZone	getTimeZoneByComponent(VTimezone component) Gets the TimeZone object that is assigned to a VTimezone component.
TimeZone	getTimeZoneById(String id) Gets a timezone with a given ID.
TimeZone	getTimeZoneToWriteIn(ICalProperty property) Gets the timezone that a property should be formatted in when written.
boolean	hasSolidusTimezone(ICalProperty property) Determines if the given property has a solidus timezone (a globally unique timezone ID).
boolean	isFloating(ICalProperty property) Determines if a property value should be formatted in floating time or not.
void	setDefaultTimeZone(TimeZone timezone) Sets the timezone to format all date/time values in.
void	setFloating(ICalProperty property, boolean enable) Instructs the writer to format a particular property's date/time value in floating time.
void	setGenerator(VTimezoneGenerator generator) Sets the timezone generator.
void	setGlobalFloatingTime(boolean enable) Sets whether to format all date/time values as floating times.
void	setTimeZone(ICalProperty property, TimeZone timezone) Instructs the writer to format an individual property's date/time value in a specific timezone.
void	setTimeZone(ICalProperty property, TimeZone timezone, boolean generateComponent) Instructs the writer to format an individual property's date/time value in a specific timezone.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimezoneInfo

public TimezoneInfo()

Method Detail

assign

public void assign(VTimezone component,
          TimeZone timezone)

Assigns a user-defined VTimezone component to its Java TimeZone equivalent.

Parameters:

component - the timezone component

timezone - the timezone object

setDefaultTimeZone

public void setDefaultTimeZone(TimeZone timezone)

Sets the timezone to format all date/time values in. An attempt will be made to generate a VTimezone component if one has not already been assigned to the given timezone (see assign()).

Parameters:

timezone - the timezone object or null for UTC (default)

Throws:

IllegalArgumentException - if a VTimezone component could not be generated

setGlobalFloatingTime

public void setGlobalFloatingTime(boolean enable)

Sets whether to format all date/time values as floating times. A floating time value does not have a timezone associated with it, and is to be interpreted as being in the local timezone of the parsing computer.

Parameters:

enable - true to enable, false to disable (default)

setTimeZone

public void setTimeZone(ICalProperty property,
               TimeZone timezone)

Instructs the writer to format an individual property's date/time value in a specific timezone.

Parameters:

property - the property

timezone - the timezone or null to format the property according to the default timezone (default)

setTimeZone

public void setTimeZone(ICalProperty property,
               TimeZone timezone,
               boolean generateComponent)

Instructs the writer to format an individual property's date/time value in a specific timezone.

Parameters:

property - the property

timezone - the timezone or null to format the property according to the default timezone (default)

generateComponent - true to associate the property with a VTimezone component containing the timezone definition (recommended), false not to. If the "timezone" parameter is null, then this parameter has no effect

getTimeZone

public TimeZone getTimeZone(ICalProperty property)

Gets the timezone that is assigned to a property.

Parameters:

property - the property

Returns:

the timezone or null if no timezone is assigned to the property

hasSolidusTimezone

public boolean hasSolidusTimezone(ICalProperty property)

Determines if the given property has a solidus timezone (a globally unique timezone ID).

Parameters:

property - the property

Returns:

true if the property has a solidus timezone, false if not

getTimeZoneToWriteIn

public TimeZone getTimeZoneToWriteIn(ICalProperty property)

Gets the timezone that a property should be formatted in when written. You should call isFloating(biweekly.property.ICalProperty) first, to check to see if the property's value is floating (without a timezone).

Parameters:

property - the property

Returns:

the timezone or null for UTC

getTimeZoneById

public TimeZone getTimeZoneById(String id)

Gets a timezone with a given ID.

Parameters:

id - the ID

Returns:

the timezone or null if not found

getTimeZoneByComponent

public TimeZone getTimeZoneByComponent(VTimezone component)

Gets the TimeZone object that is assigned to a VTimezone component.

Parameters:

component - the component

Returns:

the timezone object or null if none were found

getComponent

public VTimezone getComponent(ICalProperty property)

Gets the VTimezone component that a property is assigned to.

Parameters:

property - the property

Returns:

the component or null if it is not assigned to one

setFloating

public void setFloating(ICalProperty property,
               boolean enable)

Instructs the writer to format a particular property's date/time value in floating time. A floating time value does not have a timezone associated with it, and is to be interpreted as being in the local timezone of the parsing computer.

Parameters:

property - the property whose value should be formatted as a floating time value

enable - true to enable floating time for this property, false to disable (default)

isFloating

public boolean isFloating(ICalProperty property)

Determines if a property value should be formatted in floating time or not.

Parameters:

property - the property

Returns:

true to format in floating time, false not to

getComponents

public Collection<VTimezone> getComponents()

Gets all of the iCalendar VTimezone components that have been registered or generated by this class.

Returns:

the timezone components

getGenerator

public VTimezoneGenerator getGenerator()

Gets the timezone generator.

Returns:

the timezone generator

setGenerator

public void setGenerator(VTimezoneGenerator generator)

Sets the timezone generator.

Parameters:

generator - the timezone generator