Class VJournal

All Implemented Interfaces:
VAttendee<VJournal>, VComponent, VDescribable<VJournal>, VLastModified<VJournal>, VRepeatable<VJournal>, VChild, VElement, VParent

public class VJournal extends VDisplayable<VJournal>
VJOURNAL Journal Component RFC 5545, 3.6.3, page 57 A "VJOURNAL" calendar component is a grouping of component properties that represent one or more descriptive text notes associated with a particular calendar date. The "DTSTART" property is used to specify the calendar date with which the journal entry is associated. Generally, it will have a DATE value data type, but it can also be used to specify a DATE-TIME value data type. Examples of a journal entry include a daily record of a legislative body or a journal entry of individual telephone contacts for the day or an ordered list of accomplishments for the day. The "VJOURNAL" calendar component can also be used to associate a document with a calendar date. The "VJOURNAL" calendar component does not take up time on a calendar. Hence, it does not play a role in free or busy time searches -- it is as though it has a time transparency value of TRANSPARENT. It is transparent to any such searches. The "VJOURNAL" calendar component cannot be nested within another calendar component. However, "VJOURNAL" calendar components can be related to each other or to a "VEVENT" or to a "VTODO" calendar component, with the "RELATED-TO" property. Example: The following is an example of the "VJOURNAL" calendar component: BEGIN:VJOURNAL UID:19970901T130000Z-123405@example.com DTSTAMP:19970901T130000Z DTSTART;VALUE=DATE:19970317 SUMMARY:Staff meeting minutes DESCRIPTION:1. Staff meeting: Participants include Joe\, Lisa\, and Bob. Aurora project plans were reviewed. There is currently no budget reserves for this project. Lisa will escalate to management. Next meeting on Tuesday.\n 2. Telephone Conference: ABC Corp. sales representative called to discuss new printer. Promised to get us a demo by Friday.\n3. Henry Miller (Handsoff Insurance): Car was totaled by tree. Is looking into a loaner car. 555-2323 (tel). END:VJOURNAL
  • Field Details

  • Constructor Details

    • VJournal

      public VJournal()
    • VJournal

      public VJournal(VJournal source)
      Copy constructor
  • Method Details

    • getDescriptions

      public List<Description> getDescriptions()
      DESCRIPTION: RFC 5545 iCalendar 3.8.1.12. page 84 This property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. Example: DESCRIPTION:Meeting to provide technical review for "Phoenix" design.\nHappy Face Conference Room. Phoenix design team MUST attend this meeting.\nRSVP to team leader. VJournal can have multiple description properties.
    • setDescriptions

      public void setDescriptions(List<Description> descriptions)
    • withDescriptions

      public VJournal withDescriptions(List<Description> descriptions)
    • withDescriptions

      public VJournal withDescriptions(String... descriptions)
    • withDescriptions

      public VJournal withDescriptions(Description... descriptions)
    • calendarList

      public List<VJournal> calendarList()
    • errors

      public List<String> errors()
      Description copied from interface: VElement
      Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent
      Specified by:
      errors in interface VElement
      Overrides:
      errors in class VDisplayable<VJournal>
      Returns:
      - list of error messages
    • parse

      public static VJournal parse(String content)
      Creates a new VJournal calendar component by parsing a String of iCalendar content lines
      Parameters:
      content - the text to parse, not null
      Returns:
      the parsed VJournal