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

Class LocationType

java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Property
net.fortuna.ical4j.model.property.LocationType
All Implemented Interfaces:
Serializable, Comparable<Property>, FluentProperty, Prototype<Property>
public class LocationType extends Property
 6.1.  Location Type

    Property name:  LOCATION-TYPE

    Purpose:  To specify the type(s) of a location.

    Value type:  The value type for this property is TEXT.  The allowable
       values are defined below.

    Description:  This property MAY be specified in VLOCATION components
       and provides a way to differentiate multiple locations.  For
       example, it allows event producers to provide location information
       for the venue and the parking.

    Format Definition:

    This property is defined by the following notation:

       loctype      = "LOCATION-TYPE" loctypeparam ":"
                      text *("," text)
                      CRLF

       loctypeparam   = *(";" other-param)

       Multiple values may be used if the location has multiple purposes,
       for example a hotel and a restaurant.

       Values for this parameter are taken from the values defined in
       [RFC4589] section 3.  New location types SHOULD be registered in
       the manner laid down in section 5 of that specification.
See Also:

  • Constructor Details

    • LocationType

      public LocationType()
      Default constructor.

    • LocationType

      public LocationType(String aValue)
      Parameters:
      aValue - a value string for this component

    • LocationType

      public LocationType(ParameterList aList, String aValue)
      Parameters:
      aList - a list of parameters for this component
      aValue - a value string for this component

    • LocationType

      public LocationType(List<String> cList)
      Parameters:
      cList - a list of locationTypes

    • LocationType

      public LocationType(ParameterList aList, List<String> cList)
      Parameters:
      aList - a list of parameters for this component
      cList - a list of locationTypes

    • LocationType

      public LocationType(LocationType... locationTypes)

    • LocationType

      public LocationType(ParameterList params, LocationType... locationTypes)

  • Method Details

    • 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

    • getLocationTypes

      public final List<String> getLocationTypes()
      Returns:
      Returns the locationTypes.

    • getValue

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

    • validate

      public ValidationResult validate() throws ValidationException
      Description copied from class: Property
      Perform validation on a property.
      Specified by:
      validate in class Property
      Throws:
      ValidationException - where the property is not in a valid state

    • newFactory

      protected PropertyFactory<LocationType> 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