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

public Class FreeBusy

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.DateTimePropertyValidators, org.threeten.extra.Interval, java.util.ArrayList, .List

$Id$

Created: [Apr 14, 2004]

Defines a FREEBUSY iCalendar component property.

    4.8.2.6 Free/Busy Time

       Property Name: FREEBUSY

       Purpose: The property defines one or more free or busy time
       intervals.

       Value Type: PERIOD. The date and time values MUST be in an UTC time
       format.

       Property Parameters: Non-standard or free/busy time type property
       parameters can be specified on this property.

       Conformance: The property can be specified in a "VFREEBUSY" calendar
       component.

       Property Parameter: "FBTYPE" and non-standard parameters can be
       specified on this property.

       Description: These time periods can be specified as either a start
       and end date-time or a start date-time and duration. The date and
       time MUST be a UTC time format.

       "FREEBUSY" properties within the "VFREEBUSY" calendar component
       SHOULD be sorted in ascending order, based on start time and then end
       time, with the earliest periods first.

       The "FREEBUSY" property can specify more than one value, separated by
       the COMMA character (US-ASCII decimal 44). In such cases, the
       "FREEBUSY" property values SHOULD all be of the same "FBTYPE"
       property parameter type (e.g., all values of a particular "FBTYPE"
       listed together in a single property).

       Format Definition: The property is defined by the following notation:

         freebusy   = "FREEBUSY" fbparam ":" fbvalue
                      CRLF

         fbparam    = *(
                    ; the following is optional,
                    ; but MUST NOT occur more than once

                    (";" fbtypeparam) /

                    ; the following is optional,
                    ; and MAY occur more than once

                    (";" xparam)

                    )

         fbvalue    = period *["," period]
         ;Time value MUST be in the UTC time format.
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private List<Interval>
private static final long
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
FreeBusy()

Default constructor.

public
FreeBusy(final String
a freebusy value
aValue
)

public
FreeBusy(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
FreeBusy(final List<Interval>
a list of periods
pList
)

public
FreeBusy(final ParameterList
a list of parameters for this component
aList
,
final List<Interval>
a list of periods
pList
)

Method Summary

Modifier and TypeMethod and Description
public final List<Interval>

Returns:

Returns the periods.
getIntervals
()

public final String
protected PropertyFactory<FreeBusy>
newFactory()

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

Returns a new property factory used to create deep copies.

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

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

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

intervalsback to summary
private List<Interval> intervals
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

FreeBusyback to summary
public FreeBusy()

Default constructor.

FreeBusyback to summary
public FreeBusy(final String aValue)
Parameters
aValue:String

a freebusy value

FreeBusyback to summary
public FreeBusy(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

FreeBusyback to summary
public FreeBusy(final List<Interval> pList)
Parameters
pList:List<Interval>

a list of periods

FreeBusyback to summary
public FreeBusy(final ParameterList aList, final List<Interval> pList)
Parameters
aList:ParameterList

a list of parameters for this component

pList:List<Interval>

a list of periods

Method Detail

getIntervalsback to summary
public final List<Interval> getIntervals()
Returns:List<Interval>

Returns the periods.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<FreeBusy> newFactory()

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

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

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<FreeBusy>

a property factory instance

Annotations
@Override
setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

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

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

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

Perform validation on a property.

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

public Class FreeBusy.Factory

extends Factory
implements PropertyFactory<FreeBusy>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public FreeBusy
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

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

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public FreeBusy createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:FreeBusy

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public FreeBusy createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:FreeBusy

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override