Class Categories

  • All Implemented Interfaces:
    Serializable, Comparable<Property>

    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)
    
                         )
     
    See Also:
    Serialized Form
    • 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
      • getCategories

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

        public final String getValue()
        Specified by:
        getValue in class Content
        Returns:
        the content value