biweekly.io

Class WriteContext

java.lang.Object

biweekly.io.WriteContext

public class WriteContext
extends Object

Stores information used to write the properties in an iCalendar object.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
WriteContext(ICalVersion version, TimezoneInfo timezoneOptions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDate(ICalDate date, boolean floating, TimeZone tz) Records the timezoned date-time values that are being written.
List<Date>	getDates() Gets the timezoned date-time property values that are in the iCalendar object.
ICalComponent	getParent() Gets the parent component of the property that is being written.
TimezoneInfo	getTimezoneInfo() Gets the timezone options for this iCalendar object.
ICalVersion	getVersion() Gets the version of the iCalendar object that is being written.
void	setParent(ICalComponent parent) Sets the parent component of the property that is being written.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteContext

public WriteContext(ICalVersion version,
            TimezoneInfo timezoneOptions)

Method Detail

getVersion

public ICalVersion getVersion()

Gets the version of the iCalendar object that is being written.

Returns:

the iCalendar version

getTimezoneInfo

public TimezoneInfo getTimezoneInfo()

Gets the timezone options for this iCalendar object.

Returns:

the timezone options

getParent

public ICalComponent getParent()

Gets the parent component of the property that is being written.

Returns:

the parent component

setParent

public void setParent(ICalComponent parent)

Sets the parent component of the property that is being written.

Parameters:

parent - the parent component

getDates

public List<Date> getDates()

Gets the timezoned date-time property values that are in the iCalendar object.

Returns:

the timezoned date-time property values

addDate

public void addDate(ICalDate date,
           boolean floating,
           TimeZone tz)

Records the timezoned date-time values that are being written. This is used to generate a DAYLIGHT property for vCalendar objects.

Parameters:

floating - true if the date is floating, false if not

tz - the timezone to format the date in or null for UTC

date - the date value