net.fortuna.ical4j.model.property
Class Summary

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

public class Summary
extends Property
implements Escapable

$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
 

Author:
Ben Fortuna
See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.fortuna.ical4j.model.Property
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 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
copy, equals, getName, getParameter, getParameters, getParameters, hashCode, isCalendarProperty, 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
Perform validation on a property.

Specified by:
validate in class Property
Throws:
ValidationException - where the property is not in a valid state

setValue

public final void setValue(String aValue)
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 Content
Returns:
the content value


Copyright © 2004-2012 Micronode. All Rights Reserved.