Class Location

  • All Implemented Interfaces:
    Serializable, Comparable<Property>, Encodable

    public class Location
    extends Property
    implements Encodable
    $Id$

    Created: [Apr 6, 2004]

    Defines a LOCATION iCalendar component property.

         4.8.1.7 Location
    
            Property Name: LOCATION
    
            Purpose: The property defines the intended venue for the activity
            defined by a calendar component.
    
            Value Type: TEXT
    
            Property Parameters: Non-standard, alternate text representation and
            language property parameters can be specified on this property.
    
            Conformance: This property can be specified in "VEVENT" or "VTODO"
            calendar component.
    
            Description: Specific venues such as conference or meeting rooms may
            be explicitly specified using this property. An alternate
            representation may be specified that is a URI that points to
            directory information with more structured specification of the
            location. For example, the alternate representation may specify
            either an LDAP URI pointing to an LDAP server entry or a CID URI
            pointing to a MIME body part containing a vCard [RFC 2426] for the
            location.
    
            Format Definition: The property is defined by the following notation:
    
              location   = "LOCATION locparam ":" text CRLF
    
              locparam   = *(
    
                         ; the following are optional,
                         ; but MUST NOT occur more than once
    
                         (";" altrepparam) / (";" languageparam) /
    
                         ; the following is optional,
                         ; and MAY occur more than once
    
                         (";" xparam)
    
                         )
    
            Example: The following are some examples of this property:
    
              LOCATION:Conference Room - F123, Bldg. 002
    
              LOCATION;ALTREP="http://xyzcorp.com/conf-rooms/f123.vcf":
               Conference Room - F123, Bldg. 002
     
    See Also:
    Serialized Form
    • Constructor Detail

      • Location

        public Location()
        Default constructor.
      • Location

        public Location​(String aValue)
        Parameters:
        aValue - a value string for this component
      • Location

        public Location​(ParameterList aList,
                        String aValue)
        Parameters:
        aList - a list of parameters for this component
        aValue - a value string for this component
    • Method Detail

      • setValue

        public final void setValue​(String aValue)
        Sets the current value of the property.
        Specified by:
        setValue in class Property
        Parameters:
        aValue - a string representation of the property value
      • getValue

        public final String getValue()
        Specified by:
        getValue in class Content
        Returns:
        the content value
      • newFactory

        protected PropertyFactory<Location> newFactory()
        Description copied from class: Property
        Returns a new property factory used to create deep copies.
        Specified by:
        newFactory in class Property
        Returns:
        a property factory instance