Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class Categories

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.DescriptivePropertyValidators

$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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private TextList
private static final long
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
Categories()

Default constructor.

public
Categories(final String
a value string for this component
aValue
)

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

public
Categories(final TextList
a list of categories
cList
)

public
Categories(final ParameterList
a list of parameters for this component
aList
,
TextList
a list of categories
cList
)

Method Summary

Modifier and TypeMethod and Description
public void
addCategory(String category)

public TextList

Returns:

Returns the categories.
getCategories
()

public String
protected PropertyFactory<Categories>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public void
public void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

categoriesback to summary
private TextList categories
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

Categoriesback to summary
public Categories()

Default constructor.

Categoriesback to summary
public Categories(final String aValue)
Parameters
aValue:String

a value string for this component

Categoriesback to summary
public Categories(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Categoriesback to summary
public Categories(final TextList cList)
Parameters
cList:TextList

a list of categories

Categoriesback to summary
public Categories(final ParameterList aList, TextList cList)
Parameters
aList:ParameterList

a list of parameters for this component

cList:TextList

a list of categories

Method Detail

addCategoryback to summary
public void addCategory(String category)
getCategoriesback to summary
public TextList getCategories()
Returns:TextList

Returns the categories.

getValueback to summary
public String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<Categories> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<Categories>

a property factory instance

Annotations
@Override
removeCategoryback to summary
public void removeCategory(String category)
setValueback to summary
public void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class Categories.Factory

extends Factory
implements PropertyFactory<Categories>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Categories
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public Categories
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public Categories createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:Categories

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public Categories createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:Categories

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override