biweekly.property

Class FreeBusy

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ListProperty<Period>

biweekly.property.FreeBusy

public class FreeBusy
extends ListProperty<Period>

Defines a person's availability over certain time periods (for example, "busy" between 1pm-3pm and 4pm-5pm). Note that this property can contain multiple time periods, but only one availability type may be defined (e.g. "busy" or "free").

Code sample:

 VFreeBusy fb = new VFreeBusy();
 
 FreeBusy freebusy = new FreeBusy();
 freebusy.setType(FreeBusyType.BUSY);
 
 Date onePM = ...
 Date threePM = ...
 freebusy.getValues().add(new Period(onePM, threePM));
 
 fb.addFreeBusy(freebusy);
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.100-1, RFC 2445 p.95-6

Field Summary

Fields inherited from class biweekly.property.ListProperty

values

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
FreeBusy()
FreeBusy(FreeBusy original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
FreeBusy	copy() Creates a copy of this property object.
FreeBusyType	getType() Gets the person's status over the time periods that are specified in this property (for example, "free" or "busy").
void	setType(FreeBusyType fbType) Sets the person's status over the time periods that are specified in this property (for example, "free" or "busy").
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.ListProperty

equals, getValues, hashCode, toStringValues

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeBusy

public FreeBusy()

FreeBusy

public FreeBusy(FreeBusy original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getType

public FreeBusyType getType()

Gets the person's status over the time periods that are specified in this property (for example, "free" or "busy"). If not set, the user should be considered "busy".

Returns:

the type or null if not set

See Also:

RFC 5545 p.20

setType

public void setType(FreeBusyType fbType)

Sets the person's status over the time periods that are specified in this property (for example, "free" or "busy"). If not set, the user should be considered "busy".

Parameters:

fbType - the type or null to remove

See Also:

RFC 5545 p.20

validate

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

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the specifications.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ListProperty<Period>

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

copy

public FreeBusy copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy