Class VAvailability
java.lang.Object
net.fortuna.ical4j.model.Component
net.fortuna.ical4j.model.component.CalendarComponent
net.fortuna.ical4j.model.component.VAvailability
- All Implemented Interfaces:
Serializable,ComponentContainer<Available>,FluentComponent,PropertyContainer
$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:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class net.fortuna.ical4j.model.component.CalendarComponent
EMPTY_VALIDATORFields inherited from class net.fortuna.ical4j.model.Component
AVAILABLE, BEGIN, components, END, EXPERIMENTAL_PREFIX, PARTICIPANT, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VLOCATION, VRESOURCE, VTIMEZONE, VTODO, VVENUE -
Constructor Summary
ConstructorsConstructorDescriptionDefault 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 TypeMethodDescriptionfinal ComponentList<Available>Returns the list of available times.protected ValidatorgetValidator(Method method) 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, validateRequestMethods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, copy, equals, getFluentTarget, getName, getProperties, getRequiredProperty, hashCode, toString, validate, validatePropertiesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.fortuna.ical4j.model.ComponentContainer
getComponent, getComponentsMethods inherited from interface net.fortuna.ical4j.model.FluentComponent
withPropertyMethods inherited from interface net.fortuna.ical4j.model.PropertyContainer
getProperties, getProperty
-
Constructor Details
-
VAvailability
public VAvailability()Default constructor. -
VAvailability
public VAvailability(boolean initialise) -
VAvailability
Constructs a new instance containing the specified properties.- Parameters:
properties- a list of properties
-
VAvailability
Constructor.- Parameters:
properties- a list of propertiesavailable- a list of available components
-
-
Method Details
-
getAvailable
Returns the list of available times.- Returns:
- a component list
-
getComponents
- Specified by:
getComponentsin interfaceComponentContainer<Available>
-
validate
Perform validation on a component.- Specified by:
validatein classComponent- Parameters:
recurse- indicates whether to validate the component's properties- Throws:
ValidationException- where the component is not in a valid state
-
getValidator
- Specified by:
getValidatorin classCalendarComponent- Parameters:
method- a method to validate on- Returns:
- a validator for the specified method or null if the method is not supported
-