Class Categories

java.lang.Object

jfxtras.icalendarfx.VElementBase

jfxtras.icalendarfx.VParentBase<Categories>

jfxtras.icalendarfx.properties.VPropertyBase<List<String>, Categories>

jfxtras.icalendarfx.properties.PropBaseLanguage<List<String>, Categories>

jfxtras.icalendarfx.properties.component.descriptive.Categories

All Implemented Interfaces:

PropLanguage<List<String>>, VProperty<List<String>>, VChild, VElement, VParent

public class Categories
extends PropBaseLanguage<List<String>, Categories>

3.8.1.2. Categories

Property Name: CATEGORIES

Purpose: This property defines the categories for a calendar component.

Value Type: TEXT

Property Parameters: IANA, 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 COMMA-separated list of categories.

Format Definition: This property is defined by the following notation:

• categories
  • "CATEGORIES" catparam ":" text *("," text) CRLF
• catparam
  • The following are OPTIONAL, but MUST NOT occur more than once.
    • ";" Language for text
  • The following are OPTIONAL, and MAY occur more than once.
    • other-param
      • ";" NonStandardParameter
      • ";"
        invalid reference

        IANAParameter

  Example: The following is an example of this property with formatted line breaks in the property value:

  • CATEGORIES:APPOINTMENT,EDUCATION
  • CATEGORIES:MEETING

Nested Class Summary

Nested classes/interfaces inherited from class VElementBase

VElementBase.Message, VElementBase.MessageEffect

Field Summary

Fields

Modifier and Type	Field	Description
private static final StringConverter<List<String>>	CONVERTER

Fields inherited from class VPropertyBase

actualValueContent, allowedValueTypes, defaultValueType, propertyName

Fields inherited from class VParentBase

contentLineGenerator, orderer

Fields inherited from class VElementBase

BEGIN, END

Constructor Summary

Constructors

Constructor	Description
Categories()
Categories(String... values)	Constructor with varargs of property values Note: Do not use to parse the content line.
Categories(List<String> values)
Categories(Categories source)

Method Summary

Modifier and Type	Method	Description
protected List<String>	copyValue(List<String> source)
static Categories	parse(String content)

Methods inherited from class PropBaseLanguage

getLanguage, setLanguage, setLanguage, withLanguage, withLanguage

Methods inherited from class VPropertyBase

equals, errors, getConverter, getNonStandard, getParent, getUnknownValue, getValue, getValueType, hashCode, modifiedValue, name, parseContent, processInLineChild, setConverter, setConverterByClass, setNonStandard, setParent, setValue, setValueType, setValueType, toString, valueContent, withNonStandard, withNonStandard, withNonStandard, withValue, withValueType

Methods inherited from class VParentBase

addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, getGetter, getGetters, getSetter, getSetters, orderChild, orderChild, orderChild, parseContent, removeChild, removeChild, replaceChild, replaceChild, withChild

Methods inherited from class VElementBase

elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface VChild

getParent, setParent

Methods inherited from interface VElement

errors, isValid, name

Methods inherited from interface VParent

addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from interface VProperty

getNonStandard, getValue, getValueType, setNonStandard, setValue, setValueType

Field Details

CONVERTER

private static final StringConverter<List<String>> CONVERTER

Constructor Details

Categories

public Categories(List<String> values)

Categories

public Categories(String... values)

Constructor with varargs of property values Note: Do not use to parse the content line. Use static parse method instead.

Categories

public Categories(Categories source)

Categories

public Categories()

Method Details

parse

public static Categories parse(String content)

copyValue

protected List<String> copyValue(List<String> source)

Overrides:

copyValue in class VPropertyBase<List<String>, Categories>