- All Implemented Interfaces:
ICalComponent
ICalComponent
because this
class represents an iCalendar's component (a VCALENDAR) has
properties associated with it and contains other iCalendar
components. Aside from the constructors, there are no public
methods other than those defined by ICalComponent
.
The documentation for ICalComponent
describes the parse
tree created when this method's constructor is called.
-
Constructor Summary
ConstructorsConstructorDescriptionICalParser
(byte[] data) Constructor.ICalParser
(byte[] data, String[] names) Constructor adding text-property names.ICalParser
(File f) Constructor given a file.ICalParser
(File f, String[] names) Constructor given a file and adding text-property names.Constructor given an input stream.ICalParser
(InputStream is, String[] names) Constructor given and input stream and adding text-property names. -
Method Summary
Modifier and TypeMethodDescriptionGet the components nested within this component.getName()
Get the name of an iCalendar component.Get the properties for an iCalendar component.
-
Constructor Details
-
ICalParser
Constructor. The byte array contains UTF-8 encoded text with CRLF end of lines as described in RFC 5545.- Parameters:
data
- the byte array containing an iCalendar- Throws:
IOException
- an IO error occurred
-
ICalParser
Constructor adding text-property names. The byte array contains UTF-8 encoded text with CRLF end of lines as described in RFC 5545.The second argument is a list of the names of additional properties (these must not be ones explicitly defined in RFC 5545) whose values are text. RFC 5545 treats text differently from other property values. In particular, a ',' or ';' can values for fields containing multiple values, with a ',' or ';' escaped to denote text.
- Parameters:
data
- the byte array containing an iCalendarnames
- a list of additional property names whose values are text fields- Throws:
IOException
- an IO error occurred
-
ICalParser
Constructor given a file. The file contains UTF-8 encoded text with CRLF end of lines as described in RFC 5545.- Parameters:
f
- the file to read- Throws:
IOException
- an error occurred while reading the input
-
ICalParser
Constructor given an input stream. The input stream contains UTF-8 encoded text with CRLF end of lines as described in- Parameters:
is
- the input stream to read- Throws:
IOException
- an error occurred while reading the input
-
ICalParser
Constructor given a file and adding text-property names. The file contains UTF-8 encoded text with CRLF end of lines as described inThe second argument is a list of the names of additional properties (these must not be ones explicitly defined in RFC 5545) whose values are text. RFC 5545 treats text differently from other property values. In particular, a ',' or ';' can values for fields containing multiple values, with a ',' or ';' escaped to denote text.
- Parameters:
f
- the file to readnames
- a list of additional property names whose values are text fields- Throws:
IOException
- an error occurred while reading the input
-
ICalParser
Constructor given and input stream and adding text-property names. The input stream contains UTF-8 encoded text with CRLF end of lines as described inThe second argument is a list of the names of additional properties (these must not be ones explicitly defined in RFC 5545) whose values are text. RFC 5545 treats text differently from other property values. In particular, a ',' or ';' can values for fields containing multiple values, with a ',' or ';' escaped to denote text.
- Parameters:
is
- the input stream to readnames
- a list of additional property names whose values are text fields- Throws:
IOException
- an error occurred while reading the input
-
-
Method Details
-
getName
Description copied from interface:ICalComponent
Get the name of an iCalendar component. the name "VCALENDAR" is the name of the top-level component. Other component names defined by RFC 5545 are "VEVENT", "VTODO", "VJOURNAL", and "VALARM".- Specified by:
getName
in interfaceICalComponent
- Returns:
- the name
-
getComponents
Description copied from interface:ICalComponent
Get the components nested within this component. Suitable components defined in RFC 5545 consist of alarms.- Specified by:
getComponents
in interfaceICalComponent
- Returns:
- a list of the nested components
-
getProperties
Description copied from interface:ICalComponent
Get the properties for an iCalendar component.- Specified by:
getProperties
in interfaceICalComponent
- Returns:
- the component's properties
-