net.fortuna.ical4j.model.property
Class Summary
Property
net.fortuna.ical4j.model.property.Summary
- Escapable
public class Summary
extends Property
implements Escapable
$Id: Summary.java,v 1.11 2008/12/16 12:34:51 fortuna Exp $
Created: [Apr 6, 2004]
Defines a SUMMARY iCalendar component property.
4.8.1.12 Summary
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
Summary
public Summary()
Default constructor.
Summary
public Summary(ParameterList aList,
String aValue)
aList
- a list of parameters for this componentaValue
- a value string for this component
Summary
public Summary(String aValue)
aValue
- a value string for this component
getValue
public final String getValue()
setValue
public final void setValue(String aValue)
validate
public final void validate()
throws ValidationException
net.fortuna.ical4j.model.Property.validate()