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

public Class VResource

extends Component
Class Inheritance
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.property.Description, .Geo, .Name, .ResourceType, net.fortuna.ical4j.validate.ComponentValidator, .ValidationException, .ValidationResult, java.util.List, .Optional

$Id$ [May 1 2017] Defines an iCalendar VRESOURCE component.
 Component name:  VRESOURCE

 Purpose:  This component provides a typed reference to external
 information about a resource or optionally a plain text typed
 value.  Typically a resource is anything that might be required or
 used by a calendar entity and possibly has a directory entry.

 Conformance:  This component can be specified multiple times in a
 "VEVENT", "VTODO", "VJOURNAL", "VFREEBUSY" or "PARTICIPANT"
 calendar component.

 Description:  When used in a component this component provides
 information about resources used for the event such as rooms,
 projectors, conferencing capabilities.

 The RESOURCE-TYPE value registry provides a place in which
 resource types may be registered.

 STRUCTURED-DATA properties if present may refer to representations
 of the resource - such as a vCard.

 Format Definition:

 This component is defined by the following notation:

 resourcec    = "BEGIN" ":" "VRESOURCE" CRLF
                resprop
                "END" ":" "VRESOURCE" CRLF

 resprop      = ; the elements herein may appear in any order,
                ; and the order is not significant.

                uid

                (name)
                (description)
                (geo)
                (restype)

sdataprop
iana-prop

 The NAME property is defined in [RFC7986]

 
Author
Mike Douglass

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VResource.Factory

Default factory.

Field Summary

Modifier and TypeField and Description
private static final long
Inherited from net.fortuna.ical4j.model.Component:
AVAILABLEBEGINcomponentsENDEXPERIMENTAL_PREFIXPARTICIPANTpropertiesVALARMVAVAILABILITYVEVENTVFREEBUSYVJOURNALVLOCATIONVRESOURCEVTIMEZONEVTODOVVENUE

Constructor Summary

AccessConstructor and Description
public
VResource()

Default constructor.

public
VResource(final PropertyList
a list of properties
properties
)

Constructor.

public
VResource(final PropertyList
a list of properties
properties
,
final ComponentList<Component> components)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public final Optional<Description>

Returns:

the DESCRIPTION property or null if not specified
getDescription
()

Returns the optional description property.

public final Optional<Geo>

Returns:

the optional geo property for a vresource
getGeo
()

public final Optional<Name>

Returns:

the optional name property for a vresource
getNameProp
()

public Optional<ResourceType>

Returns:

the ResourceType property or null if not specified
getResourceType
()

Returns the optional ResourceType property.

public final List<Property>

Returns:

the optional structured data properties
getStructuredData
()

protected ComponentFactory<VResource>
newFactory()

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

Returns a new component factory used to create deep copies.

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:
calculateRecurrenceSetcompareTocopyequalsgetFluentTargetgetNamegetPropertiesgetPropertyListgetUidgetValuehashCodesetPropertyListtoStringvalidatevalidateProperties

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Component.serialVersionUID.

Constructor Detail

VResourceback to summary
public VResource()

Default constructor.

VResourceback to summary
public VResource(final PropertyList properties)

Constructor.

Parameters
properties:PropertyList

a list of properties

VResourceback to summary
public VResource(final PropertyList properties, final ComponentList<Component> components)

Constructor.

Parameters
properties:PropertyList

a list of properties

Method Detail

getDescriptionback to summary
public final Optional<Description> getDescription()

Returns the optional description property.

Returns:Optional<Description>

the DESCRIPTION property or null if not specified

getGeoback to summary
public final Optional<Geo> getGeo()
Returns:Optional<Geo>

the optional geo property for a vresource

getNamePropback to summary
public final Optional<Name> getNameProp()
Returns:Optional<Name>

the optional name property for a vresource

getResourceTypeback to summary
public Optional<ResourceType> getResourceType()

Returns the optional ResourceType property.

Returns:Optional<ResourceType>

the ResourceType property or null if not specified

getStructuredDataback to summary
public final List<Property> getStructuredData()
Returns:List<Property>

the optional structured data properties

newFactoryback to summary
protected ComponentFactory<VResource> 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<VResource>

a component factory instance

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

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

public Class VResource.Factory

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

Default factory.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public VResource
public VResource
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createComponentback to summary
public VResource createComponent()

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

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

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

Annotations
@Override