Interface VComponent

All Superinterfaces:
VChild, VElement, VParent
All Known Subinterfaces:
VAttendee<T>, VDateTimeEnd<T>, VDescribable<T>, VDescribable2<T>, VDuration<T>, VLastModified<T>, VRepeatable<T>
All Known Implementing Classes:
DaylightSavingTime, NonStandardComponent, StandardOrDaylight, StandardTime, VAlarm, VCommon, VComponentBase, VDescribableBase, VDisplayable, VEvent, VFreeBusy, VJournal, VLocatable, VPersonal, VPrimary, VRepeatableBase, VTimeZone, VTodo

public interface VComponent extends VParent, VChild

RFC 5545, 3.6. Calendar Components

The body of the iCalendar object consists of a sequence of calendar properties and one or more calendar components. The calendar properties are attributes that apply to the calendar object as a whole. The calendar components are collections of properties that express a particular calendar semantic. For example, the calendar component can specify an event, a to-do, a journal entry, time zone information, free/busy time information, or an alarm.

The body of the iCalendar object is defined by the following notation:

  • icalbody = calprops component
  • calprops
    • The following are REQUIRED, but MUST NOT occur more than once.
    • The following are OPTIONAL, but MUST NOT occur more than once.
    • The following are OPTIONAL, and MAY occur more than once.
  • component

An iCalendar object MUST include the PRODID and VERSION calendar properties. In addition, it MUST include at least one calendar component. Special forms of iCalendar objects are possible to publish just busy time (i.e., only a VFREEBUSY calendar component) or time zone (i.e., only a VTIMEZONE calendar component) information. In addition, a complex iCalendar object that is used to capture a complete snapshot of the contents of a calendar is possible (e.g., composite of many different calendar components). More commonly, an iCalendar object will consist of just a single VEVENT, VTODO, or VJOURNAL calendar component. Applications MUST ignore x-comp and iana-comp values they don't recognize. Applications that support importing iCalendar objects SHOULD support all of the component types defined in this document, and SHOULD NOT silently drop any components as that can lead to user data loss.</P

  • Method Details

    • toString

      String toString()

      Returns content line for a calendar component. See RFC 5545 3.4 Contains component properties with their values and any parameters.

      The following is a example of iCalendar content text:

        BEGIN:VEVENT
        UID:19970610T172345Z-AF23B2@example.com
        DTSTAMP:19970610T172345Z
        DTSTART:19970714T170000Z
        DTEND:19970715T040000Z
        SUMMARY:Bastille Day Party
        END:VEVENT

      Overrides:
      toString in class Object
      Returns:
      - the component content lines
    • calendarList

      List<? extends VComponent> calendarList()