net.fortuna.ical4j.model.property
Class Summary

java.lang.Object
  extended bynet.fortuna.ical4j.model.Content
      extended bynet.fortuna.ical4j.model.Property
          extended bynet.fortuna.ical4j.model.property.Summary
All Implemented Interfaces:
Escapable, Serializable

public class Summary
extends Property
implements Escapable

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
 

Author:
Ben Fortuna
See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.fortuna.ical4j.model.Property
ACTION, ATTACH, ATTENDEE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, FREEBUSY, GEO, LAST_MODIFIED, LOCATION, METHOD, ORGANIZER, PERCENT_COMPLETE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, SUMMARY, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION
 
Constructor Summary
Summary()
          Default constructor.
Summary(ParameterList aList, String aValue)
           
Summary(String aValue)
           
 
Method Summary
 String getValue()
           
 void setValue(String aValue)
          Sets the current value of the property.
 void validate()
          Perform validation on a property.
 
Methods inherited from class net.fortuna.ical4j.model.Property
equals, getName, getParameter, getParameters, getParameters, hashCode, isCalendarProperty, isComponentProperty, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

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 component
aValue - a value string for this component
Method Detail

validate

public final void validate()
                    throws ValidationException
Description copied from class: Property
Perform validation on a property.

Specified by:
validate in class Property
Throws:
ValidationException - where the property is not in a valid state
See Also:
Property.validate()

setValue

public final void setValue(String aValue)
Description copied from class: Property
Sets the current value of the property.

Specified by:
setValue in class Property
Parameters:
aValue - a string representation of the property value

getValue

public final String getValue()
Specified by:
getValue in class Property
Returns:
Returns the value.