Module ical4j.core
Package net.fortuna.ical4j.model.component

Class VResource

java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Component
net.fortuna.ical4j.model.component.VResource
All Implemented Interfaces:
Serializable, Comparable<Component>, FluentComponent, PropertyContainer, PropertyListAccessor, Prototype<Component>
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:

  • Constructor Details

    • VResource

      public VResource()
      Default constructor.

    • VResource

      public VResource(PropertyList properties)
      Constructor.
      Parameters:
      properties - a list of properties

    • VResource

      public VResource(PropertyList properties, ComponentList<Component> components)
      Constructor.
      Parameters:
      properties - a list of properties

  • Method Details

    • validate

      public ValidationResult validate(boolean recurse) throws ValidationException
      Perform validation on a component.
      Specified by:
      validate in class Component
      Parameters:
      recurse - indicates whether to validate the component's properties
      Throws:
      ValidationException - where the component is not in a valid state

    • getDescription

      public final Optional<Description> getDescription()
      Returns the optional description property.
      Returns:
      the DESCRIPTION property or null if not specified

    • getGeo

      public final Optional<Geo> getGeo()
      Returns:
      the optional geo property for a vresource

    • getResourceType

      public Optional<ResourceType> getResourceType()
      Returns the optional ResourceType property.
      Returns:
      the ResourceType property or null if not specified

    • getNameProp

      public final Optional<Name> getNameProp()
      Returns:
      the optional name property for a vresource

    • getStructuredData

      public final List<Property> getStructuredData()
      Returns:
      the optional structured data properties

    • newFactory

      protected ComponentFactory<VResource> newFactory()
      Description copied from class: Component
      Returns a new component factory used to create deep copies.
      Specified by:
      newFactory in class Component
      Returns:
      a component factory instance