- All Known Implementing Classes:
ICalParser
public interface ICalComponent
The iCalendar component interface.
This interface is used for parsing iCalendar objects.
Each component is characterized by a collection of properties and a collection of iCalendar components that are parts of this component (for example, the event and to-do components contain alarm components). The relation between the classes presenting components, properties, and parameters is shown in the following UML diagram:
Starting from the top-level component (an instance ofICalParser
), calling getComponents()
will
return a list of the components with the same parent. For any
level, the method getProperties()
will return
a list of ICalProperty
objects containing the properties of
that component.
-
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.
-
Method Details
-
getName
String getName()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".- Returns:
- the name
-
getProperties
List<ICalProperty> getProperties()Get the properties for an iCalendar component.- Returns:
- the component's properties
-
getComponents
List<ICalComponent> getComponents()Get the components nested within this component. Suitable components defined in RFC 5545 consist of alarms.- Returns:
- a list of the nested components
-