Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class LocationType

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.validate.PropertyValidator, .ValidationException, .ValidationResult, java.util.ArrayList, .Arrays, .Collections, .List, java.util.stream.Collectors

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.
Author
Mike Douglass, Ben Fortuna
See Also
Event Publishing Extensions to iCalendar

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private List<String>
private static final long
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
LocationType()

Default constructor.

public
LocationType(final String
a value string for this component
aValue
)

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

public
LocationType(final List<String>
a list of locationTypes
cList
)

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

public
LocationType(LocationType... locationTypes)

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

Method Summary

Modifier and TypeMethod and Description
public final List<String>

Returns:

Returns the locationTypes.
getLocationTypes
()

public final String
protected PropertyFactory<LocationType>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

locationTypesback to summary
private List<String> locationTypes
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

Constructor Detail

LocationTypeback to summary
public LocationType()

Default constructor.

LocationTypeback to summary
public LocationType(final String aValue)
Parameters
aValue:String

a value string for this component

LocationTypeback to summary
public LocationType(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

LocationTypeback to summary
public LocationType(final List<String> cList)
Parameters
cList:List<String>

a list of locationTypes

LocationTypeback to summary
public LocationType(final ParameterList aList, final List<String> cList)
Parameters
aList:ParameterList

a list of parameters for this component

cList:List<String>

a list of locationTypes

LocationTypeback to summary
public LocationType(LocationType... locationTypes)
LocationTypeback to summary
public LocationType(ParameterList params, LocationType... locationTypes)

Method Detail

getLocationTypesback to summary
public final List<String> getLocationTypes()
Returns:List<String>

Returns the locationTypes.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<LocationType> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<LocationType>

a property factory instance

Annotations
@Override
setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class LocationType.Factory

extends Factory
implements PropertyFactory<LocationType>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public LocationType
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public LocationType
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public LocationType createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:LocationType

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public LocationType createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:LocationType

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override