biweekly

Class ICalendar

java.lang.Object

biweekly.component.ICalComponent

biweekly.ICalendar

public class ICalendar
extends ICalComponent

Represents an iCalendar object.

Examples:

 ICalendar ical = new ICalendar();
 
 VEvent event = new VEvent();
 event.setSummary("Team Meeting");
 Date start = ...;
 event.setDateStart(start);
 Date end = ...;
 event.setDateEnd(end);
 ical.addEvent(event);
 

Author:

Michael Angstadt

See Also:

RFC 5545, RFC 2445, vCal 1.0, draft-ietf-calext-extensions-01

Field Summary

Fields inherited from class biweekly.component.ICalComponent

components, properties

Constructor Summary

Constructors

Constructor and Description
ICalendar() Creates a new iCalendar object.
ICalendar(ICalendar original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCategories(Categories categories) Adds a list of keywords that describe the calendar.
Categories	addCategories(String... categories) Adds a list of keywords that describe the calendar.
void	addDescription(Description description) Assigns a human-readable description to the calendar as a whole.
Description	addDescription(String description) Assigns a human-readable description to the calendar as a whole.
void	addEvent(VEvent event) Adds an event to the calendar.
void	addFreeBusy(VFreeBusy freeBusy) Adds a free/busy entry to the calendar.
void	addImage(Image image) Adds an image that is associated with the calendar.
void	addJournal(VJournal journal) Adds a journal entry to the calendar.
void	addName(Name name) Assigns a human-readable name to the calendar as a whole.
Name	addName(String name) Assigns a human-readable name to the calendar as a whole.
void	addTodo(VTodo todo) Adds a to-do task to the calendar.
boolean	equals(Object obj)
CalendarScale	getCalendarScale() Gets the calendar system that this iCalendar object uses.
List<Categories>	getCategories() Gets the keywords that describe the calendar.
Color	getColor() Gets the color that clients may use when displaying the calendar (for example, a background color).
List<Description>	getDescriptions() Gets the human-readable description of the calendar as a whole.
List<VEvent>	getEvents() Gets the calendar's events.
List<VFreeBusy>	getFreeBusies() Gets the calendar's free/busy entries.
List<Image>	getImages() Gets the images that are associated with the calendar.
List<VJournal>	getJournals() Gets the calendar's journal entries.
LastModified	getLastModified() Gets the date and time that the information in this calendar object was last revised.
Method	getMethod() Gets the type of iTIP request that this iCalendar object represents, or the value of the "Content-Type" header's "method" parameter if the iCalendar object is defined as a MIME message entity.
List<Name>	getNames() Gets the human-readable name of the calendar as a whole.
ProductId	getProductId() Gets the name of the application that created the iCalendar object.
RefreshInterval	getRefreshInterval() Gets the suggested minimum polling interval for checking for updates to the calendar data.
Source	getSource() Gets the location that the calendar data can be refreshed from.
List<VTodo>	getTodos() Gets the calendar's to-do tasks.
Uid	getUid() Gets the calendar's unique identifier.
Url	getUrl() Gets the location of a more dynamic, alternate representation of the calendar (such as a website that allows you to interact with the calendar data).
ICalVersion	getVersion() Gets the version of this iCalendar object.
int	hashCode()
void	setCalendarScale(CalendarScale calendarScale) Sets the calendar system that this iCalendar object uses.
void	setColor(Color color) Sets the color that clients may use when displaying the calendar (for example, a background color).
Color	setColor(String color) Sets the color that clients may use when displaying the calendar (for example, a background color).
void	setDescription(Description description) Sets the human-readable description of the calendar as a whole.
Description	setDescription(String description) Sets the human-readable description of the calendar as a whole.
LastModified	setLastModified(Date lastModified) Sets the date and time that the information in this calendar object was last revised.
void	setLastModified(LastModified lastModified) Sets the date and time that the information in this calendar object was last revised.
void	setMethod(Method method) Sets the type of iTIP request that this iCalendar object represents, or the value of the "Content-Type" header's "method" parameter if the iCalendar object is defined as a MIME message entity.
Method	setMethod(String method) Sets the type of iTIP request that this iCalendar object represents, or the value of the "Content-Type" header's "method" parameter if the iCalendar object is defined as a MIME message entity.
void	setName(Name name) Sets the human-readable name of the calendar as a whole.
Name	setName(String name) Sets the human-readable name of the calendar as a whole.
void	setProductId(ProductId prodId) Sets the name of the application that created the iCalendar object.
ProductId	setProductId(String prodId) Sets the application that created the iCalendar object.
RefreshInterval	setRefreshInterval(Duration refreshInterval) Sets the suggested minimum polling interval for checking for updates to the calendar data.
void	setRefreshInterval(RefreshInterval refreshInterval) Sets the suggested minimum polling interval for checking for updates to the calendar data.
void	setSource(Source source) Sets the location that the calendar data can be refreshed from.
Source	setSource(String url) Sets the location that the calendar data can be refreshed from.
Uid	setUid(String uid) Sets the calendar's unique identifier.
void	setUid(Uid uid) Sets the calendar's unique identifier.
Url	setUrl(String url) Sets the location of a more dynamic, alternate representation of the calendar (such as a website that allows you to interact with the calendar data).
void	setUrl(Url url) Sets the location of a more dynamic, alternate representation of the calendar (such as a website that allows you to interact with the calendar data).
void	setVersion(ICalVersion version) Sets the version of this iCalendar object.
protected Map<String,Object>	toStringValues() Gets string representations of any additional fields the component has (other than sub-components and properties) for the ICalComponent.toString() method.
ValidationWarnings	validate(ICalVersion version) Checks this iCalendar object for data consistency problems or deviations from the specifications.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the component for data consistency problems or deviations from the spec.
String	write() Marshals this iCalendar object to its traditional, plain-text representation.
void	write(File file) Marshals this iCalendar object to its traditional, plain-text representation.
void	write(OutputStream out) Marshals this iCalendar object to its traditional, plain-text representation.
void	write(Writer writer) Marshals this iCalendar object to its traditional, plain-text representation.
String	writeJson() Marshals this iCalendar object to its JSON representation (jCal).
void	writeJson(File file) Marshals this iCalendar object to its JSON representation (jCal).
void	writeJson(OutputStream out) Marshals this iCalendar object to its JSON representation (jCal).
void	writeJson(Writer writer) Marshals this iCalendar object to its JSON representation (jCal).
String	writeXml() Marshals this iCalendar object to its XML representation (xCal).
void	writeXml(File file) Marshals this iCalendar object to its XML representation (xCal).
void	writeXml(OutputStream out) Marshals this iCalendar object to its XML representation (xCal).
void	writeXml(Writer writer) Marshals this iCalendar object to its XML representation (xCal).

Methods inherited from class biweekly.component.ICalComponent

addComponent, addExperimentalComponent, addExperimentalProperty, addExperimentalProperty, addProperty, checkOptionalCardinality, checkRequiredCardinality, checkStatus, copy, getComponent, getComponents, getComponents, getExperimentalComponent, getExperimentalComponents, getExperimentalComponents, getExperimentalProperties, getExperimentalProperties, getExperimentalProperty, getProperties, getProperties, getProperty, removeComponent, removeComponents, removeExperimentalComponents, removeExperimentalProperties, removeProperties, removeProperty, setComponent, setComponent, setExperimentalComponent, setExperimentalProperty, setExperimentalProperty, setProperty, setProperty, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ICalendar

public ICalendar()

Creates a new iCalendar object.

The following properties are added to the component when it is created:

• ProductId: Set to a value that represents this library.

ICalendar

public ICalendar(ICalendar original)

Copy constructor.

Parameters:

original - the iCalendar object to make a copy of

Method Detail

getVersion

public ICalVersion getVersion()

Gets the version of this iCalendar object.

Returns:

the version

setVersion

public void setVersion(ICalVersion version)

Sets the version of this iCalendar object.

Parameters:

version - the version

getProductId

public ProductId getProductId()

Gets the name of the application that created the iCalendar object. All ICalendar objects are initialized with a product ID representing this library.

Returns:

the property instance or null if not set

See Also:

RFC 5545 p.78-9, RFC 2445 p.75-6, vCal 1.0 p.24

setProductId

public void setProductId(ProductId prodId)

Sets the name of the application that created the iCalendar object. All ICalendar objects are initialized with a product ID representing this library.

Parameters:

prodId - the property instance or null to remove

See Also:

RFC 5545 p.78-9, RFC 2445 p.75-6, vCal 1.0 p.24

setProductId

public ProductId setProductId(String prodId)

Sets the application that created the iCalendar object. All ICalendar objects are initialized with a product ID representing this library.

Parameters:

prodId - a unique string representing the application (e.g. "-//Company//Application//EN") or null to remove

Returns:

the property that was created

See Also:

RFC 5545 p.78-9, RFC 2445 p.75-6, vCal 1.0 p.24

getCalendarScale

public CalendarScale getCalendarScale()

Gets the calendar system that this iCalendar object uses. If none is specified, then the calendar is assumed to be in Gregorian format.

Returns:

the calendar system or null if not set

See Also:

RFC 5545 p.76-7, RFC 2445 p.73-4

setCalendarScale

public void setCalendarScale(CalendarScale calendarScale)

Sets the calendar system that this iCalendar object uses. If none is specified, then the calendar is assumed to be in Gregorian format.

Parameters:

calendarScale - the calendar system or null to remove

See Also:

RFC 5545 p.76-7, RFC 2445 p.73-4

getMethod

public Method getMethod()

Gets the type of iTIP request that this iCalendar object represents, or the value of the "Content-Type" header's "method" parameter if the iCalendar object is defined as a MIME message entity.

Returns:

the property or null if not set

See Also:

RFC 5546, RFC 5545 p.77-8, RFC 2445 p.74-5

setMethod

public void setMethod(Method method)

Sets the type of iTIP request that this iCalendar object represents, or the value of the "Content-Type" header's "method" parameter if the iCalendar object is defined as a MIME message entity.

Parameters:

method - the property or null to remove

See Also:

RFC 5546, RFC 5545 p.77-8, RFC 2445 p.74-5

setMethod

public Method setMethod(String method)

Sets the type of iTIP request that this iCalendar object represents, or the value of the "Content-Type" header's "method" parameter if the iCalendar object is defined as a MIME message entity.

Parameters:

method - the method or null to remove

Returns:

the property that was created

See Also:

RFC 5546, RFC 5545 p.77-8, RFC 2445 p.74-5

getNames

public List<Name> getNames()

Gets the human-readable name of the calendar as a whole.

An iCalendar object can only have one name, but multiple Name properties can exist in order to specify the name in multiple languages. In this case, each property instance must be assigned a LANGUAGE parameter.

Returns:

the names (any changes made this list will affect the parent component object and vice versa)

See Also:

draft-ietf-calext-extensions-01 p.5

setName

public void setName(Name name)

Sets the human-readable name of the calendar as a whole.

Parameters:

name - the name or null to remove

See Also:

draft-ietf-calext-extensions-01 p.5

setName

public Name setName(String name)

Sets the human-readable name of the calendar as a whole.

Parameters:

name - the name or null to remove

Returns:

the property that was created

See Also:

draft-ietf-calext-extensions-01 p.5

addName

public void addName(Name name)

Assigns a human-readable name to the calendar as a whole.

An iCalendar object can only have one name, but multiple Name properties can exist in order to specify the name in multiple languages. In this case, each property instance must be assigned a LANGUAGE parameter.

Parameters:

name - the name

See Also:

draft-ietf-calext-extensions-01 p.5

addName

public Name addName(String name)

Assigns a human-readable name to the calendar as a whole.

An iCalendar object can only have one name, but multiple Name properties can exist in order to specify the name in multiple languages. In this case, each property instance must be assigned a LANGUAGE parameter.

Parameters:

name - the name (e.g. "Company Vacation Days")

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.5

getDescriptions

public List<Description> getDescriptions()

Gets the human-readable description of the calendar as a whole.

An iCalendar object can only have one description, but multiple Description properties can exist in order to specify the description in multiple languages. In this case, each property instance must be assigned a LANGUAGE parameter.

Returns:

the descriptions (any changes made this list will affect the parent component object and vice versa)

See Also:

draft-ietf-calext-extensions-01 p.6

setDescription

public void setDescription(Description description)

Sets the human-readable description of the calendar as a whole.

Parameters:

description - the description or null to remove

See Also:

draft-ietf-calext-extensions-01 p.6

setDescription

public Description setDescription(String description)

Sets the human-readable description of the calendar as a whole.

Parameters:

description - the description or null to remove

Returns:

the property that was created

See Also:

draft-ietf-calext-extensions-01 p.6

addDescription

public void addDescription(Description description)

Assigns a human-readable description to the calendar as a whole.

An iCalendar object can only have one description, but multiple Description properties can exist in order to specify the description in multiple languages. In this case, each property instance must be assigned a LANGUAGE parameter.

Parameters:

description - the description

See Also:

draft-ietf-calext-extensions-01 p.6

addDescription

public Description addDescription(String description)

Assigns a human-readable description to the calendar as a whole.

An iCalendar object can only have one description, but multiple Description properties can exist in order to specify the description in multiple languages. In this case, each property instance must be assigned a LANGUAGE parameter.

Parameters:

description - the description

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.6

getUid

public Uid getUid()

Gets the calendar's unique identifier.

Returns:

the unique identifier or null if not set

See Also:

draft-ietf-calext-extensions-01 p.6

setUid

public void setUid(Uid uid)

Sets the calendar's unique identifier.

Parameters:

uid - the unique identifier or null to remove

See Also:

draft-ietf-calext-extensions-01 p.6

setUid

public Uid setUid(String uid)

Sets the calendar's unique identifier.

Parameters:

uid - the unique identifier or null to remove

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.6

getLastModified

public LastModified getLastModified()

Gets the date and time that the information in this calendar object was last revised.

Returns:

the last modified time or null if not set

See Also:

draft-ietf-calext-extensions-01 p.7

setLastModified

public void setLastModified(LastModified lastModified)

Sets the date and time that the information in this calendar object was last revised.

Parameters:

lastModified - the last modified time or null to remove

See Also:

draft-ietf-calext-extensions-01 p.7

setLastModified

public LastModified setLastModified(Date lastModified)

Sets the date and time that the information in this calendar object was last revised.

Parameters:

lastModified - the date and time or null to remove

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.7

getUrl

public Url getUrl()

Gets the location of a more dynamic, alternate representation of the calendar (such as a website that allows you to interact with the calendar data).

Returns:

the URL or null if not set

See Also:

draft-ietf-calext-extensions-01 p.7

setUrl

public void setUrl(Url url)

Sets the location of a more dynamic, alternate representation of the calendar (such as a website that allows you to interact with the calendar data).

Parameters:

url - the URL or null to remove

See Also:

draft-ietf-calext-extensions-01 p.7

setUrl

public Url setUrl(String url)

Sets the location of a more dynamic, alternate representation of the calendar (such as a website that allows you to interact with the calendar data).

Parameters:

url - the URL or null to remove

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.7

getCategories

public List<Categories> getCategories()

Gets the keywords that describe the calendar.

Returns:

the categories (any changes made this list will affect the parent component object and vice versa)

See Also:

draft-ietf-calext-extensions-01 p.7

addCategories

public void addCategories(Categories categories)

Adds a list of keywords that describe the calendar.

Parameters:

categories - the categories to add

See Also:

draft-ietf-calext-extensions-01 p.7

addCategories

public Categories addCategories(String... categories)

Adds a list of keywords that describe the calendar.

Parameters:

categories - the categories to add

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.7

getRefreshInterval

public RefreshInterval getRefreshInterval()

Gets the suggested minimum polling interval for checking for updates to the calendar data.

Returns:

the refresh interval or null if not set

See Also:

draft-ietf-calext-extensions-01 p.7

setRefreshInterval

public void setRefreshInterval(RefreshInterval refreshInterval)

Sets the suggested minimum polling interval for checking for updates to the calendar data.

Parameters:

refreshInterval - the refresh interval or null to remove

See Also:

draft-ietf-calext-extensions-01 p.7

setRefreshInterval

public RefreshInterval setRefreshInterval(Duration refreshInterval)

Sets the suggested minimum polling interval for checking for updates to the calendar data.

Parameters:

refreshInterval - the refresh interval or null to remove

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.7

getSource

public Source getSource()

Gets the location that the calendar data can be refreshed from.

Returns:

the source or null if not set

See Also:

draft-ietf-calext-extensions-01 p.8

setSource

public void setSource(Source source)

Sets the location that the calendar data can be refreshed from.

Parameters:

source - the source or null to remove

See Also:

draft-ietf-calext-extensions-01 p.8

setSource

public Source setSource(String url)

Sets the location that the calendar data can be refreshed from.

Parameters:

url - the source or null to remove

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.8

getColor

public Color getColor()

Gets the color that clients may use when displaying the calendar (for example, a background color).

Returns:

the color or null if not set

See Also:

draft-ietf-calext-extensions-01 p.9

setColor

public void setColor(Color color)

Sets the color that clients may use when displaying the calendar (for example, a background color).

Parameters:

color - the color or null to remove

See Also:

draft-ietf-calext-extensions-01 p.9

setColor

public Color setColor(String color)

Sets the color that clients may use when displaying the calendar (for example, a background color).

Parameters:

color - the color name (case insensitive) or null to remove. Acceptable values are defined in Section 4.3 of the CSS Color Module Level 3 Recommendation. For example, "aliceblue", "green", "navy".

Returns:

the property object that was created

See Also:

draft-ietf-calext-extensions-01 p.9

getImages

public List<Image> getImages()

Gets the images that are associated with the calendar.

Returns:

the images (any changes made this list will affect the parent component object and vice versa)

See Also:

draft-ietf-calext-extensions-01 p.10

addImage

public void addImage(Image image)

Adds an image that is associated with the calendar.

Parameters:

image - the image

See Also:

draft-ietf-calext-extensions-01 p.10

getEvents

public List<VEvent> getEvents()

Gets the calendar's events.

Returns:

the events (any changes made this list will affect the parent component object and vice versa)

See Also:

RFC 5545 p.52-5, RFC 2445 p.52-4, vCal 1.0 p.13

addEvent

public void addEvent(VEvent event)

Adds an event to the calendar.

Parameters:

event - the event

See Also:

RFC 5545 p.52-5, RFC 2445 p.52-4, vCal 1.0 p.13

getTodos

public List<VTodo> getTodos()

Gets the calendar's to-do tasks.

Returns:

the to-do tasks (any changes made this list will affect the parent component object and vice versa)

See Also:

RFC 5545 p.55-7, RFC 2445 p.55-6, vCal 1.0 p.14

addTodo

public void addTodo(VTodo todo)

Adds a to-do task to the calendar.

Parameters:

todo - the to-do task

See Also:

RFC 5545 p.55-7, RFC 2445 p.55-6, vCal 1.0 p.14

getJournals

public List<VJournal> getJournals()

Gets the calendar's journal entries.

Returns:

the journal entries (any changes made this list will affect the parent component object and vice versa)

See Also:

RFC 5545 p.57-9, RFC 2445 p.56-7

addJournal

public void addJournal(VJournal journal)

Adds a journal entry to the calendar.

Parameters:

journal - the journal entry

See Also:

RFC 5545 p.57-9, RFC 2445 p.56-7

getFreeBusies

public List<VFreeBusy> getFreeBusies()

Gets the calendar's free/busy entries.

Returns:

the free/busy entries (any changes made this list will affect the parent component object and vice versa)

See Also:

RFC 5545 p.59-62, RFC 2445 p.58-60

addFreeBusy

public void addFreeBusy(VFreeBusy freeBusy)

Adds a free/busy entry to the calendar.

Parameters:

freeBusy - the free/busy entry

See Also:

RFC 5545 p.59-62, RFC 2445 p.58-60

validate

public ValidationWarnings validate(ICalVersion version)

Checks this iCalendar object for data consistency problems or deviations from the specifications.

The existence of validation warnings will not prevent the iCalendar object from being written to a data stream. Syntactically-correct output will still be produced. However, the consuming application may have trouble interpreting some of the data due to the presence of these warnings.

These problems can largely be avoided by reading the Javadocs of the component and property classes, or by being familiar with the iCalendar standard.

Parameters:

version - the version to validate against

Returns:

the validation warnings

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalComponent

Checks the component for data consistency problems or deviations from the spec.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalComponent

Parameters:

components - the hierarchy of components that the component belongs to

version - the version to validate against

warnings - the list to add the warnings to

write

public String write()

Marshals this iCalendar object to its traditional, plain-text representation.

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or ICalWriter classes instead in order to register the scribe classes.

Returns:

the plain text representation

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

write

public void write(File file)
           throws IOException

Marshals this iCalendar object to its traditional, plain-text representation.

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or ICalWriter classes instead in order to register the scribe classes.

Parameters:

file - the file to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

IOException - if there's an problem writing to the file

write

public void write(OutputStream out)
           throws IOException

Marshals this iCalendar object to its traditional, plain-text representation.

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or ICalWriter classes instead in order to register the scribe classes.

Parameters:

out - the output stream to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

IOException - if there's a problem writing to the output stream

write

public void write(Writer writer)
           throws IOException

Marshals this iCalendar object to its traditional, plain-text representation.

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or ICalWriter classes instead in order to register the scribe classes.

Parameters:

writer - the writer to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

IOException - if there's a problem writing to the writer

writeXml

public String writeXml()

Marshals this iCalendar object to its XML representation (xCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly, XCalWriter, or XCalDocument classes instead in order to register the scribe classes.

Returns:

the XML document

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

writeXml

public void writeXml(File file)
              throws TransformerException,
                     IOException

Marshals this iCalendar object to its XML representation (xCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly, XCalWriter, or XCalDocument classes instead in order to register the scribe classes.

Parameters:

file - the file to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

TransformerException - if there's a problem writing to the file

IOException - if there's a problem opening the file

writeXml

public void writeXml(OutputStream out)
              throws TransformerException

Marshals this iCalendar object to its XML representation (xCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly, XCalWriter, or XCalDocument classes instead in order to register the scribe classes.

Parameters:

out - the output stream to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

TransformerException - if there's a problem writing to the output stream

writeXml

public void writeXml(Writer writer)
              throws TransformerException

Marshals this iCalendar object to its XML representation (xCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly, XCalWriter, or XCalDocument classes instead in order to register the scribe classes.

Parameters:

writer - the writer to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

TransformerException - if there's a problem writing to the writer

writeJson

public String writeJson()

Marshals this iCalendar object to its JSON representation (jCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or JCalWriter classes instead in order to register the scribe classes.

Returns:

the JSON string

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

writeJson

public void writeJson(File file)
               throws IOException

Marshals this iCalendar object to its JSON representation (jCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or JCalWriter classes instead in order to register the scribe classes.

Parameters:

file - the file to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

IOException - if there's a problem writing to the file

writeJson

public void writeJson(OutputStream out)
               throws IOException

Marshals this iCalendar object to its JSON representation (jCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or JCalWriter classes instead in order to register the scribe classes.

Parameters:

out - the output stream to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

IOException - if there's a problem writing to the output stream

writeJson

public void writeJson(Writer writer)
               throws IOException

Marshals this iCalendar object to its JSON representation (jCal).

If this iCalendar object contains user-defined property or component objects, you must use the Biweekly or JCalWriter classes instead in order to register the scribe classes.

Parameters:

writer - the writer to write to

Throws:

IllegalArgumentException - if this iCalendar object contains user-defined property or component objects

IOException - if there's a problem writing to the writer

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: ICalComponent

Gets string representations of any additional fields the component has (other than sub-components and properties) for the ICalComponent.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class ICalComponent

Returns:

the values of the component's fields (key = field name, value = field value)

hashCode

public int hashCode()

Overrides:

hashCode in class ICalComponent

equals

public boolean equals(Object obj)

Overrides:

equals in class ICalComponent