net.fortuna.ical4j.model.property
Class Categories

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

public class Categories
extends Property

$Id$ Created: [Apr 6, 2004] Defines a CATEGORIES iCalendar component property.

     4.8.1.2 Categories
     
        Property Name: CATEGORIES
     
        Purpose: This property defines the categories for a calendar
        component.
     
        Value Type: TEXT
     
        Property Parameters: Non-standard and language property parameters
        can be specified on this property.
     
        Conformance: The property can be specified within "VEVENT", "VTODO"
        or "VJOURNAL" calendar components.
     
        Description: This property is used to specify categories or subtypes
        of the calendar component. The categories are useful in searching for
        a calendar component of a particular type and category. Within the
        "VEVENT", "VTODO" or "VJOURNAL" calendar components, more than one
        category can be specified as a list of categories separated by the
        COMMA character (US-ASCII decimal 44).
     
        Format Definition: The property is defined by the following notation:
     
          categories = "CATEGORIES" catparam ":" text *("," text)
                       CRLF
     
          catparam   = *(
     
                     ; the following is optional,
                     ; but MUST NOT occur more than once
     
                     (";" languageparam ) /
     
                     ; the following is optional,
                     ; and MAY occur more than once
     
                     (";" xparam)
     
                     )
 

Author:
benf
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
Categories()
          Default constructor.
Categories(ParameterList aList, String aValue)
           
Categories(ParameterList aList, TextList cList)
           
Categories(String aValue)
           
Categories(TextList cList)
           
 
Method Summary
 TextList getCategories()
           
 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

Categories

public Categories()
Default constructor.


Categories

public Categories(String aValue)
Parameters:
aValue - a value string for this component

Categories

public Categories(ParameterList aList,
                  String aValue)
Parameters:
aList - a list of parameters for this component
aValue - a value string for this component

Categories

public Categories(TextList cList)
Parameters:
cList - a list of categories

Categories

public Categories(ParameterList aList,
                  TextList cList)
Parameters:
aList - a list of parameters for this component
cList - a list of categories
Method Detail

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

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

getCategories

public final TextList getCategories()
Returns:
Returns the categories.

getValue

public final String getValue()

Specified by:
getValue in class Content
Returns:
the content value


Copyright © 2004-2012 Micronode. All Rights Reserved.