Package net.fortuna.ical4j.model.component

Class VLocation

  • All Implemented Interfaces:
    Serializable, FluentComponent, PropertyContainer, PropertyListAccessor
    public class VLocation
extends Component
    $Id$ [May 1 2017] Defines an iCalendar VLOCATION component. 
     Component name:  VLOCATION

 Purpose:  This component provides rich information about the location
 of an event using the structured data property or optionally a
 plain text typed value.

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

 Description:  There may be a number of locations associated with an
 event.  This component provides detailed information about a
 location.

 When used in a component the value of this property provides
 information about the event venue or of related services such as
 parking, dining, stations etc..

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

 Format Definition:

 This component is defined by the following notation:

 locationc    = "BEGIN" ":" "VLOCATION" CRLF
                locprop
                "END" ":" "VLOCATION" CRLF

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

                uid

                (name)
                (description)
                (geo)
                (loctype)

sdataprop
iana-prop

 The NAME property is defined in [RFC7986]
    See Also:
    Serialized Form

    • Constructor Detail

      • VLocation

        public VLocation()
        Default constructor.

      • VLocation

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

    • Method Detail

      • 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 vlocation

      • getLocationType

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

      • getNameProp

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

      • getUid

        public final Optional<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 List<Property> getStructuredData()
        Returns:
        the optional structured data properties