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
Collection<VTimezone>	getComponents() Gets all of the iCalendar VTimezone components that have been registered with this object.
TimezoneAssignment	getDefaultTimezone() Gets the timezone to format all date/time values in (by default, all dates are formatted in UTC).
TimezoneAssignment	getTimezone(ICalProperty property) Gets the timezone that is assigned to a property.
TimezoneAssignment	getTimezoneById(String tzid) Gets the timezone whose VTimezone component contains a TimezoneId property with the given value.
Collection<TimezoneAssignment>	getTimezones() Gets all the timezones assigned to this object.
TimezoneAssignment	getTimezoneToWriteIn(ICalProperty property) Determines the timezone that a particular property should be formatted in when written to an output stream.
boolean	isFloating(ICalProperty property) Determines if a property value should be formatted in floating time when written to an output stream.
boolean	isGlobalFloatingTime() Gets whether to format all date/time values as floating times (defaults to false).
void	setDefaultTimezone(TimezoneAssignment timezone) Sets the timezone to format all date/time values in (by default, all dates are formatted in UTC).
void	setFloating(ICalProperty property, boolean enable) Sets whether a property value should be formatted in floating time when written to an output stream (by default, floating time is disabled for all properties).
void	setGlobalFloatingTime(boolean enable) Sets whether to format all date/time values as floating times (defaults to false).
void	setTimezone(ICalProperty property, TimezoneAssignment timezone) Assigns a timezone to a specific property.

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

getTimezones

public Collection<TimezoneAssignment> getTimezones()

Gets all the timezones assigned to this object.

Returns:

the timezones (collection is mutable)

getDefaultTimezone

public TimezoneAssignment getDefaultTimezone()

Gets the timezone to format all date/time values in (by default, all dates are formatted in UTC).

The default timezone is not used for properties that are configured to use their own timezone (see setTimezone(biweekly.property.ICalProperty, biweekly.io.TimezoneAssignment)).

Returns:

the timezone or null if using UTC

setDefaultTimezone

public void setDefaultTimezone(TimezoneAssignment timezone)

Sets the timezone to format all date/time values in (by default, all dates are formatted in UTC).

The default timezone is not used for properties that are configured to use their own timezone (see setTimezone(biweekly.property.ICalProperty, biweekly.io.TimezoneAssignment)).

Parameters:

timezone - the timezone or null to use UTC

setTimezone

public void setTimezone(ICalProperty property,
               TimezoneAssignment timezone)

Assigns a timezone to a specific property.

Parameters:

property - the property

timezone - the timezone or null to format the property according to the default timezone (see setDefaultTimezone(biweekly.io.TimezoneAssignment)).

getTimezone

public TimezoneAssignment 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

getTimezoneToWriteIn

public TimezoneAssignment getTimezoneToWriteIn(ICalProperty property)

Determines the timezone that a particular property should be formatted in when written to an output stream.

Note: You should call isFloating(biweekly.property.ICalProperty) first, to determine if the property's value is floating (without a timezone).

Parameters:

property - the property

Returns:

the timezone or null for UTC

getTimezoneById

public TimezoneAssignment getTimezoneById(String tzid)

Gets the timezone whose VTimezone component contains a TimezoneId property with the given value.

Parameters:

tzid - the value of the TimezoneId property

Returns:

the timezone or null if not found

isGlobalFloatingTime

public boolean isGlobalFloatingTime()

Gets whether to format all date/time values as floating times (defaults to false).

This setting does not apply to properties whose floating time settings are configured individually (see: setFloating(biweekly.property.ICalProperty, boolean)) or that are configured to use their own timezone (see setTimezone(biweekly.property.ICalProperty, biweekly.io.TimezoneAssignment)).

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 computer that is consuming the iCalendar object.

Returns:

true if enabled, false if disabled

setGlobalFloatingTime

public void setGlobalFloatingTime(boolean enable)

Sets whether to format all date/time values as floating times (defaults to false).

This setting does not apply to properties whose floating time settings are configured individually (see: setFloating(biweekly.property.ICalProperty, boolean)) or that are configured to use their own timezone (see setTimezone(biweekly.property.ICalProperty, biweekly.io.TimezoneAssignment)).

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 computer that is consuming the iCalendar object.

Parameters:

enable - true to enable, false to disable

isFloating

public boolean isFloating(ICalProperty property)

Determines if a property value should be formatted in floating time when written to an output stream.

Parameters:

property - the property

Returns:

true to format in floating time, false not to

setFloating

public void setFloating(ICalProperty property,
               boolean enable)

Sets whether a property value should be formatted in floating time when written to an output stream (by default, floating time is disabled for all properties).

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 computer that is consuming the iCalendar object.

Parameters:

property - the property

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

getComponents

public Collection<VTimezone> getComponents()

Gets all of the iCalendar VTimezone components that have been registered with this object.

Returns:

the components (this collection is immutable)