Class VResource
- java.lang.Object
-
- net.fortuna.ical4j.model.Component
-
- net.fortuna.ical4j.model.component.VResource
-
- All Implemented Interfaces:
Serializable
,PropertyContainer
public class VResource extends Component
$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]
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VResource.Factory
Default factory.
-
Field Summary
-
Fields 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
Constructors Constructor Description VResource()
Default constructor.VResource(PropertyList<Property> properties)
Constructor.VResource(PropertyList<Property> properties, ComponentList<Component> components)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Description
getDescription()
Returns the optional description property.Geo
getGeo()
Name
getNameProp()
ResourceType
getResourceType()
Returns the optional ResourceType property.PropertyList<StructuredData>
getStructuredData()
Uid
getUid()
Returns the UID property of this component if available.ValidationResult
validate(boolean recurse)
Perform validation on a component.-
Methods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, copy, equals, getName, getProperties, getRequiredProperty, hashCode, toString, validate, validateProperties
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.fortuna.ical4j.model.PropertyContainer
getProperties, getProperty
-
-
-
-
Constructor Detail
-
VResource
public VResource()
Default constructor.
-
VResource
public VResource(PropertyList<Property> properties)
Constructor.- Parameters:
properties
- a list of properties
-
VResource
public VResource(PropertyList<Property> properties, ComponentList<Component> components)
Constructor.- Parameters:
properties
- a list of properties
-
-
Method Detail
-
validate
public final ValidationResult validate(boolean recurse) throws ValidationException
Perform validation on a component.- Specified by:
validate
in classComponent
- Parameters:
recurse
- indicates whether to validate the component's properties- Throws:
ValidationException
- where the component is not in a valid state
-
getDescription
public final Description getDescription()
Returns the optional description property.- Returns:
- the DESCRIPTION property or null if not specified
-
getGeo
public final Geo getGeo()
- Returns:
- the optional geo property for a vresource
-
getResourceType
public ResourceType getResourceType()
Returns the optional ResourceType property.- Returns:
- the ResourceType property or null if not specified
-
getNameProp
public final Name getNameProp()
- Returns:
- the optional name property for a vresource
-
getUid
public final Uid getUid()
Returns the UID property of this component if available.- Returns:
- a Uid instance, or null if no UID property exists
-
getStructuredData
public final PropertyList<StructuredData> getStructuredData()
- Returns:
- the optional structured data properties
-
-