Class Summary

  • All Implemented Interfaces:
    Serializable, Comparable<Property>, Encodable

    public class Summary
    extends Property
    implements Encodable

    Created: [Apr 6, 2004]

    Defines a SUMMARY iCalendar component property.
            Property Name: SUMMARY
            Purpose: This property defines a short summary or subject for the
            calendar component.
            Value Type: TEXT
            Property Parameters: Non-standard, alternate text representation and
            language property parameters can be specified on this property.
            Conformance: The property can be specified in "VEVENT", "VTODO",
            "VJOURNAL" or "VALARM" calendar components.
            Description: This property is used in the "VEVENT", "VTODO" and
            "VJOURNAL" calendar components to capture a short, one line summary
            about the activity or journal entry.
            This property is used in the "VALARM" calendar component to capture
            the subject of an EMAIL category of alarm.
            Format Definition: The property is defined by the following notation:
              summary    = "SUMMARY" summparam ":" text CRLF
              summparam  = *(
                         ; the following are optional,
                         ; but MUST NOT occur more than once
                         (";" altrepparam) / (";" languageparam) /
                         ; the following is optional,
                         ; and MAY occur more than once
                         (";" xparam)
            Example: The following is an example of this property:
              SUMMARY:Department Party
    See Also:
    Serialized Form
    • Constructor Detail

      • Summary

        public Summary()
        Default constructor.
      • Summary

        public Summary​(String aValue)
        aValue - a value string for this component
      • Summary

        public Summary​(ParameterList aList,
                       String aValue)
        aList - a list of parameters for this component
        aValue - a value string for this component
    • Method Detail

      • setValue

        public final void setValue​(String aValue)
        Sets the current value of the property.
        Specified by:
        setValue in class Property
        aValue - a string representation of the property value
      • getValue

        public final String getValue()
        Specified by:
        getValue in class Content
        the content value