net.fortuna.ical4j.model.property

Class Categories


public class Categories
extends Property

$Id: Categories.java,v 1.14 2008/12/16 12:34:51 fortuna Exp $ 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)
     
                     )
 

Constructor Summary

Categories()
Default constructor.
Categories(CategoryList cList)
Categories(ParameterList aList, CategoryList cList)
Categories(ParameterList aList, String aValue)
Categories(String aValue)

Method Summary

CategoryList
getCategories()
String
getValue()
void
setValue(String aValue)
void
validate()

Constructor Details

Categories

public Categories()
Default constructor.

Categories

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

Categories

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

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(String aValue)
Parameters:
aValue - a value string for this component

Method Details

getCategories

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

getValue

public final String getValue()

setValue

public final void setValue(String aValue)

validate

public final void validate()
            throws ValidationException
See Also:
net.fortuna.ical4j.model.Property.validate()