Class Categories
- java.lang.Object
-
- net.fortuna.ical4j.model.Content
-
- net.fortuna.ical4j.model.Property
-
- net.fortuna.ical4j.model.property.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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Categories.Factory
-
Field Summary
-
Fields inherited from class net.fortuna.ical4j.model.Property
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, 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, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION
-
-
Constructor Summary
Constructors Constructor Description Categories()
Default constructor.Categories(String aValue)
Categories(ParameterList aList, String aValue)
Categories(ParameterList aList, TextList cList)
Categories(TextList cList)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCategory(String category)
List<String>
getCategories()
String
getValue()
protected PropertyFactory<Categories>
newFactory()
Returns a new property factory used to create deep copies.void
removeCategory(String category)
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
add, compareTo, copy, equals, getName, getParameter, getParameterList, getParameters, getRequiredParameter, hashCode, remove, removeAll, replace, setParameters, toString
-
-
-
-
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 componentaValue
- 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 componentcList
- a list of categories
-
-
Method Detail
-
addCategory
public void addCategory(String category)
-
removeCategory
public void removeCategory(String category)
-
setValue
public final void setValue(String aValue)
Sets the current value of the property.
-
getValue
public final String getValue()
-
newFactory
protected PropertyFactory<Categories> newFactory()
Description copied from class:Property
Returns a new property factory used to create deep copies.- Specified by:
newFactory
in classProperty
- Returns:
- a property factory instance
-
validate
public void validate() throws ValidationException
Description copied from class:Property
Perform validation on a property.- Specified by:
validate
in classProperty
- Throws:
ValidationException
- where the property is not in a valid state
-
-