Class Summary
- java.lang.Object
-
- net.fortuna.ical4j.model.Content
-
- net.fortuna.ical4j.model.Property
-
- net.fortuna.ical4j.model.property.Summary
-
- All Implemented Interfaces:
Serializable
,Comparable<Property>
,Encodable
public class Summary extends Property implements Encodable
$Id$ 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
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Summary.Factory
-
Field Summary
-
Fields inherited from class net.fortuna.ical4j.model.Property
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, 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, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getValue()
void
setValue(String aValue)
Sets the current value of the property.ValidationResult
validate()
Perform validation on a property.-
Methods inherited from class net.fortuna.ical4j.model.Property
compareTo, copy, equals, getName, getParameter, getParameters, getParameters, hashCode, toString
-
-
-
-
Constructor Detail
-
Summary
public Summary()
Default constructor.
-
Summary
public Summary(String aValue)
- Parameters:
aValue
- a value string for this component
-
Summary
public Summary(ParameterList aList, String aValue)
- Parameters:
aList
- a list of parameters for this componentaValue
- a value string for this component
-
-
Method Detail
-
setValue
public final void setValue(String aValue)
Sets the current value of the property.
-
getValue
public final String getValue()
-
validate
public ValidationResult validate() throws ValidationException
Description copied from class:Property
Perform validation on a property.- Specified by:
validate
in classProperty
- Throws:
ValidationException
- where the property is not in a valid state
-
-