Module ical4j.core

Package net.fortuna.ical4j.model.component

Class VAvailability

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Component

net.fortuna.ical4j.model.component.CalendarComponent

net.fortuna.ical4j.model.component.VAvailability

All Implemented Interfaces:

Serializable, Comparable<Component>, ComponentContainer<Available>, ComponentListAccessor<Available>, FluentComponent, PropertyContainer, PropertyListAccessor, Prototype<Component>

public class VAvailability
extends CalendarComponent
implements ComponentContainer<Available>

$Id$ [Apr 5, 2004] Defines an iCalendar VAVAILABILITY component.

   Component Name:  VAVAILABILITY

   Purpose:  Provide a grouping of component properties that describe
      the availability associated with a calendar user.

   Format Definition:  A "VAVAILABILITY" calendar component is defined
      by the following notation:

          availabilityc  = "BEGIN" ":" "VAVAILABILITY" CRLF
                           availabilityprop *availablec
                           "END" ":" "VAVAILABILITY" CRLF

          availabilityprop  = *(

                            ; the following are REQUIRED,
                            ; but MUST NOT occur more than once

                            dtstamp / dtstart / uid

                            ; the following are OPTIONAL,
                            ; but MUST NOT occur more than once

                            busytype / created / last-mod /
                            organizer / seq / summary / url /

                            ; either 'dtend' or 'duration' may appear
                            ; in a 'availabilityprop', but 'dtend' and
                            ; 'duration' MUST NOT occur in the same
                            ; 'availabilityprop'

                            dtend / duration /

                            ; the following are OPTIONAL,
                            ; and MAY occur more than once

                            categories / comment / contact / x-prop

                            )


 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VAvailability.Factory	Default factory.

Field Summary

Fields inherited from class net.fortuna.ical4j.model.component.CalendarComponent

EMPTY_VALIDATOR

Fields inherited from class net.fortuna.ical4j.model.Component

AVAILABLE, BEGIN, components, END, EXPERIMENTAL_PREFIX, PARTICIPANT, properties, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VLOCATION, VRESOURCE, VTIMEZONE, VTODO, VVENUE

Fields inherited from interface net.fortuna.ical4j.model.PropertyContainer

ADD_IF_NOT_PRESENT

Constructor Summary

Constructors

Constructor	Description
VAvailability()	Default constructor.
VAvailability(boolean initialise)
VAvailability(PropertyList properties)	Constructs a new instance containing the specified properties.
VAvailability(PropertyList properties, ComponentList<Available> available)	Constructor.

Method Summary

Modifier and Type	Method	Description
Component	copy()	Create a (deep) copy of this component.
final List<Available>	getAvailable()	Returns the list of available times.
ComponentList<Available>	getComponentList()
protected ComponentFactory<VAvailability>	newFactory()	Returns a new component factory used to create deep copies.
void	setComponentList(ComponentList<Available> components)
ValidationResult	validate(boolean recurse)	Perform validation on a component.

Methods inherited from class net.fortuna.ical4j.model.component.CalendarComponent

validate, validateAdd, validateCancel, validateCounter, validateDeclineCounter, validatePublish, validateRefresh, validateReply, validateRequest

Methods inherited from class net.fortuna.ical4j.model.Component

calculateRecurrenceSet, compareTo, equals, getFluentTarget, getName, getProperties, getPropertyList, getUid, getValue, hashCode, setPropertyList, toString, validate, validateProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.ComponentContainer

add, remove, replace, with

Methods inherited from interface net.fortuna.ical4j.model.ComponentListAccessor

getComponent, getComponents

Methods inherited from interface net.fortuna.ical4j.model.FluentComponent

withProperty

Methods inherited from interface net.fortuna.ical4j.model.PropertyContainer

add, addAll, remove, removeAll, removeIf, replace, with

Methods inherited from interface net.fortuna.ical4j.model.PropertyListAccessor

getProperties, getProperty, getProperty, getRequiredProperty, getRequiredProperty

Constructor Details

VAvailability

public VAvailability()

Default constructor.

VAvailability

public VAvailability(boolean initialise)

VAvailability

public VAvailability(PropertyList properties)

Constructs a new instance containing the specified properties.

Parameters:

properties - a list of properties

VAvailability

public VAvailability(PropertyList properties,
 ComponentList<Available> available)

Constructor.

Parameters:

properties - a list of properties

available - a list of available components

Method Details

getAvailable

public final List<Available> getAvailable()

Returns the list of available times.

Returns:

a component list

getComponentList

public ComponentList<Available> getComponentList()

Specified by:

getComponentList in interface ComponentListAccessor<Available>

Returns:

Returns the underlying component list.

setComponentList

public void setComponentList(ComponentList<Available> components)

Specified by:

setComponentList in interface ComponentContainer<Available>

validate

public ValidationResult validate(boolean recurse)
                          throws ValidationException

Perform validation on a component.

Specified by:

validate in class Component

Parameters:

recurse - indicates whether to validate the component's properties

Throws:

ValidationException - where the component is not in a valid state

newFactory

protected ComponentFactory<VAvailability> newFactory()

Description copied from class: Component

Returns a new component factory used to create deep copies.

Specified by:

newFactory in class Component

Returns:

a component factory instance

copy

public Component copy()

Description copied from class: Component

Create a (deep) copy of this component.

Specified by:

copy in interface Prototype<Component>

Overrides:

copy in class Component

Returns:

the component copy