public class Summary extends Property implements Escapable
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
| Modifier and Type | Class and Description |
|---|---|
static class |
Summary.Factory |
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION| Constructor and Description |
|---|
Summary()
Default constructor.
|
Summary(List<Parameter> aList,
String aValue) |
Summary(String aValue) |
| Modifier and Type | Method and Description |
|---|---|
Property |
copy()
Create a (deep) copy of this property.
|
String |
getValue() |
void |
setValue(String aValue)
Sets the current value of the property.
|
void |
validate()
Perform validation on a property.
|
equals, getName, getParameter, getParameters, getParameters, hashCode, toStringpublic Summary()
public Summary(String aValue)
aValue - a value string for this componentpublic final void setValue(String aValue)
public final String getValue()
public void validate()
throws ValidationException
Propertyvalidate in class PropertyValidationException - where the property is not in a valid state