net.fortuna.ical4j.model
Class Component

java.lang.Object
  net.fortuna.ical4j.model.Component

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CalendarComponent, Observance

public abstract class Component
extends java.lang.Object
implements java.io.Serializable

Defines an iCalendar component. Subclasses of this class provide additional validation and typed values for specific iCalendar components.

Author:

Ben Fortuna

See Also:

Serialized Form

Field Summary

static java.lang.String	BEGIN
static java.lang.String	END
static java.lang.String	EXPERIMENTAL_PREFIX
static java.lang.String	VALARM
static java.lang.String	VEVENT
static java.lang.String	VFREEBUSY
static java.lang.String	VJOURNAL
static java.lang.String	VTIMEZONE
static java.lang.String	VTODO
static java.lang.String	VVENUE

Constructor Summary

protected	Component(java.lang.String s) Constructs a new component containing no properties.
protected	Component(java.lang.String s, PropertyList p) Constructor made protected to enforce the use of ComponentFactory for component instantiation.

Method Summary

PeriodList	calculateRecurrenceSet(Period period) Calculates the recurrence set for this event using the specified period.
Component	copy() Create a (deep) copy of this component.
boolean	equals(java.lang.Object arg0) Uses ObjectUtils to test equality.
java.lang.String	getName()
PropertyList	getProperties()
PropertyList	getProperties(java.lang.String name) Convenience method for retrieving a list of named properties.
Property	getProperty(java.lang.String name) Convenience method for retrieving a named property.
int	hashCode() Uses HashCodeBuilder to build hashcode.
java.lang.String	toString()
void	validate() Perform validation on a component and its properties.
abstract void	validate(boolean recurse) Perform validation on a component.
protected void	validateProperties() Invoke validation on the component properties in its current state.

Methods inherited from class java.lang.Object

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

Field Detail

BEGIN

public static final java.lang.String BEGIN

See Also:

Constant Field Values

END

public static final java.lang.String END

See Also:

Constant Field Values

VEVENT

public static final java.lang.String VEVENT

See Also:

Constant Field Values

VTODO

public static final java.lang.String VTODO

See Also:

Constant Field Values

VJOURNAL

public static final java.lang.String VJOURNAL

See Also:

Constant Field Values

VFREEBUSY

public static final java.lang.String VFREEBUSY

See Also:

Constant Field Values

VTIMEZONE

public static final java.lang.String VTIMEZONE

See Also:

Constant Field Values

VALARM

public static final java.lang.String VALARM

See Also:

Constant Field Values

VVENUE

public static final java.lang.String VVENUE

See Also:

Constant Field Values

EXPERIMENTAL_PREFIX

public static final java.lang.String EXPERIMENTAL_PREFIX

See Also:

Constant Field Values

Constructor Detail

Component

protected Component(java.lang.String s)

Constructs a new component containing no properties.

Parameters:

s - a component name

Component

protected Component(java.lang.String s,
                    PropertyList p)

Constructor made protected to enforce the use of ComponentFactory for component instantiation.

Parameters:

s - component name

p - a list of properties

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getName

public final java.lang.String getName()

Returns:

Returns the name.

getProperties

public final PropertyList getProperties()

Returns:

Returns the properties.

getProperties

public final PropertyList getProperties(java.lang.String name)

Convenience method for retrieving a list of named properties.

Parameters:

name - name of properties to retrieve

Returns:

a property list containing only properties with the specified name

getProperty

public final Property getProperty(java.lang.String name)

Convenience method for retrieving a named property.

Parameters:

name - name of the property to retrieve

Returns:

the first matching property in the property list with the specified name

validate

public final void validate()
                    throws ValidationException

Perform validation on a component and its properties.

Throws:

ValidationException - where the component is not in a valid state

validate

public abstract void validate(boolean recurse)
                       throws ValidationException

Perform validation on a component.

Parameters:

recurse - indicates whether to validate the component's properties

Throws:

ValidationException - where the component is not in a valid state

validateProperties

protected final void validateProperties()
                                 throws ValidationException

Invoke validation on the component properties in its current state.

Throws:

ValidationException - where any of the component properties is not in a valid state

equals

public boolean equals(java.lang.Object arg0)

Uses ObjectUtils to test equality. Two components are equal if and only if their name and property lists are equal.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Uses HashCodeBuilder to build hashcode.

Overrides:

hashCode in class java.lang.Object

copy

public Component copy()
               throws java.text.ParseException,
                      java.io.IOException,
                      java.net.URISyntaxException

Create a (deep) copy of this component.

Returns:

the component copy

Throws:

java.text.ParseException

java.io.IOException

java.net.URISyntaxException

calculateRecurrenceSet

public final PeriodList calculateRecurrenceSet(Period period)

Calculates the recurrence set for this event using the specified period. The recurrence set is derived from a combination of the event start date, recurrence rules and dates, and exception rules and dates. Note that component transparency and anniversary-style dates do not affect the resulting intersection.

Parameters:

period -

Returns: