biweekly.property

Class EnumProperty

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.EnumProperty

Direct Known Subclasses:

Action, CalendarScale, Classification, Status, Transparency

public abstract class EnumProperty
extends TextProperty

Represents a property that has a defined set of acceptable values (for example, the Action property).

Author:

Michael Angstadt

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
EnumProperty(String value) Creates an enum property.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<String>	getStandardValues(ICalVersion version) Gets the list of acceptable values for this property.
protected Collection<ICalVersion>	getValueSupportedVersions() Gets the iCalendar versions that this property's value is supported in.
protected boolean	is(String value) Compares the property's value with a given string (case-insensitive).
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the spec.

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnumProperty

public EnumProperty(String value)

Creates an enum property.

Parameters:

value - the property value

Method Detail

is

protected boolean is(String value)

Compares the property's value with a given string (case-insensitive).

Parameters:

value - the string

Returns:

true if it's equal, false if not

getStandardValues

protected abstract Collection<String> getStandardValues(ICalVersion version)

Gets the list of acceptable values for this property.

Parameters:

version - the version

Returns:

the list of acceptable values

getValueSupportedVersions

protected Collection<ICalVersion> getValueSupportedVersions()

Gets the iCalendar versions that this property's value is supported in.

Returns:

the supported versions

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the spec.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ValuedProperty<String>

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to