Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.component

public Class VAvailability

extends CalendarComponent
implements Prototype<VAvailability>, ComponentContainer<Available>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ComponentContainer, net.fortuna.ical4j.model.ComponentListAccessor, net.fortuna.ical4j.model.Prototype
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.property.DtStamp, net.fortuna.ical4j.validate.ComponentValidator, .ValidationException, .ValidationResult, java.util.List, java.util.stream.Collectors
$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

                           )
Authors
Ben Fortuna, Mike Douglass

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VAvailability.Factory

Default factory.

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.component.CalendarComponent.serialVersionUID.

Inherited from net.fortuna.ical4j.model.component.CalendarComponent:
EMPTY_VALIDATOR

Constructor Summary

AccessConstructor and Description
public
VAvailability()

Default constructor.

public
VAvailability(boolean initialise)

public
VAvailability(final PropertyList
a list of properties
properties)

Constructs a new instance containing the specified properties.

public
VAvailability(final PropertyList
a list of properties
properties, final ComponentList<Available>
a list of available components
available)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public VAvailability
copy()

Overrides net.fortuna.ical4j.model.Component.copy.

Implements net.fortuna.ical4j.model.Prototype.copy.

Create a (deep) copy of this component.

public final List<Available>

Returns:

a component list
getAvailable()

Returns the list of available times.

public ComponentList<Available>

Returns:

Returns the underlying component list.
getComponentList()

Implements net.fortuna.ical4j.model.ComponentListAccessor.getComponentList.

protected ComponentFactory<VAvailability>
newFactory()

Implements abstract net.fortuna.ical4j.model.Component.newFactory.

Returns a new component factory used to create deep copies.

public void
setComponentList(ComponentList<Available> components)

Implements net.fortuna.ical4j.model.ComponentContainer.setComponentList.

public ValidationResult
validate(final boolean
indicates whether to validate the component's properties
recurse)

Implements abstract net.fortuna.ical4j.model.Component.validate.

Perform validation on a component.

Inherited from net.fortuna.ical4j.model.component.CalendarComponent:
validatevalidateAddvalidateCancelvalidateCountervalidateDeclineCountervalidatePublishvalidateRefreshvalidateReplyvalidateRequest

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.component.CalendarComponent.serialVersionUID.

Constructor Detail

VAvailabilityback to summary
public VAvailability()

Default constructor.

VAvailabilityback to summary
public VAvailability(boolean initialise)
VAvailabilityback to summary
public VAvailability(final PropertyList properties)

Constructs a new instance containing the specified properties.

Parameters
properties:PropertyList

a list of properties

VAvailabilityback to summary
public VAvailability(final PropertyList properties, final ComponentList<Available> available)

Constructor.

Parameters
properties:PropertyList

a list of properties

available:ComponentList<Available>

a list of available components

Method Detail

copyback to summary
public VAvailability copy()

Overrides net.fortuna.ical4j.model.Component.copy.

Implements net.fortuna.ical4j.model.Prototype.copy.

Doc from net.fortuna.ical4j.model.Component.copy.

Create a (deep) copy of this component.

Returns:VAvailability

the component copy

Annotations
@Override
getAvailableback to summary
public final List<Available> getAvailable()

Returns the list of available times.

Returns:List<Available>

a component list

getComponentListback to summary
public ComponentList<Available> getComponentList()

Implements net.fortuna.ical4j.model.ComponentListAccessor.getComponentList.

Returns:ComponentList<Available>

Returns the underlying component list.

Annotations
@Override
newFactoryback to summary
protected ComponentFactory<VAvailability> newFactory()

Implements abstract net.fortuna.ical4j.model.Component.newFactory.

Doc from net.fortuna.ical4j.model.Component.newFactory.

Returns a new component factory used to create deep copies.

Returns:ComponentFactory<VAvailability>

a component factory instance

Annotations
@Override
setComponentListback to summary
public void setComponentList(ComponentList<Available> components)

Implements net.fortuna.ical4j.model.ComponentContainer.setComponentList.

Annotations
@Override
validateback to summary
public ValidationResult validate(final boolean recurse) throws ValidationException

Implements abstract net.fortuna.ical4j.model.Component.validate.

Doc from net.fortuna.ical4j.model.Component.validate.

Perform validation on a component.

Parameters
recurse:boolean

indicates whether to validate the component's properties

Annotations
@Override
Exceptions
ValidationException:
where the component is not in a valid state
net.fortuna.ical4j.model.component back to summary

public Class VAvailability.Factory

extends Factory
implements ComponentFactory<VAvailability>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ComponentFactory
Default factory.

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public VAvailability
createComponent()

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

public VAvailability
createComponent(PropertyList properties)

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

public VAvailability
createComponent(PropertyList properties, ComponentList<?> subComponents)

Overrides default net.fortuna.ical4j.model.ComponentFactory.createComponent.

Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createComponentback to summary
public VAvailability createComponent()

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override
createComponentback to summary
public VAvailability createComponent(PropertyList properties)

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override
createComponentback to summary
public VAvailability createComponent(PropertyList properties, ComponentList<?> subComponents)

Overrides default net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override
@SuppressWarnings:unchecked