biweekly.property

Class ICalProperty

java.lang.Object

biweekly.property.ICalProperty

Direct Known Subclasses:

Attachment, Attendee, Daylight, FreeBusy, Geo, ListProperty, Organizer, RawProperty, RecurrenceDates, RequestStatus, Trigger, ValuedProperty, VCalAlarmProperty, Version

public abstract class ICalProperty
extends Object

Base class for all iCalendar properties.

Author:

Michael Angstadt

Field Summary

Fields

Modifier and Type	Field and Description
protected ICalParameters	parameters The property parameters.

Constructor Summary

Constructors

Constructor and Description
ICalProperty()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String name, String value) Adds a value to a parameter.
String	getParameter(String name) Gets the first value of a parameter with the given name.
ICalParameters	getParameters() Gets the property's parameters.
List<String>	getParameters(String name) Gets all values of a parameter with the given name.
void	removeParameter(String name) Removes a parameter from the property.
void	setParameter(String name, Collection<String> values) Replaces all existing values of a parameter with the given values.
void	setParameter(String name, String value) Replaces all existing values of a parameter with the given value.
void	setParameters(ICalParameters parameters) Sets the property's parameters
List<Warning>	validate(List<ICalComponent> components, ICalVersion version) Checks the property for data consistency problems or deviations from the spec.
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 java.lang.Object

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

Field Detail

parameters

protected ICalParameters parameters

The property parameters.

Constructor Detail

ICalProperty

public ICalProperty()

Method Detail

getParameters

public ICalParameters getParameters()

Gets the property's parameters.

Returns:

the parameters

setParameters

public void setParameters(ICalParameters parameters)

Sets the property's parameters

Parameters:

parameters - the parameters

getParameter

public String getParameter(String name)

Gets the first value of a parameter with the given name.

Parameters:

name - the parameter name (case insensitive, e.g. "LANGUAGE")

Returns:

the parameter value or null if not found

getParameters

public List<String> getParameters(String name)

Gets all values of a parameter with the given name.

Parameters:

name - the parameter name (case insensitive, e.g. "LANGUAGE")

Returns:

the parameter values

addParameter

public void addParameter(String name,
                String value)

Adds a value to a parameter.

Parameters:

name - the parameter name (case insensitive, e.g. "LANGUAGE")

value - the parameter value

setParameter

public void setParameter(String name,
                String value)

Replaces all existing values of a parameter with the given value.

Parameters:

name - the parameter name (case insensitive, e.g. "LANGUAGE")

value - the parameter value

setParameter

public void setParameter(String name,
                Collection<String> values)

Replaces all existing values of a parameter with the given values.

Parameters:

name - the parameter name (case insensitive, e.g. "LANGUAGE")

values - the parameter values

removeParameter

public void removeParameter(String name)

Removes a parameter from the property.

Parameters:

name - the parameter name (case insensitive, e.g. "LANGUAGE")

validate

public final List<Warning> validate(List<ICalComponent> components,
                     ICalVersion version)

Checks the property for data consistency problems or deviations from the spec. These problems will not prevent the property from being written to a data stream, but may prevent it from being parsed correctly by the consuming application. These problems can largely be avoided by reading the Javadocs of the property class, or by being familiar with the iCalendar standard.

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

Returns:

a list of warnings or an empty list if no problems were found

See Also:

ICalendar.validate(biweekly.ICalVersion)

validate

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

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.

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