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>

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:

Event Publishing Extensions to iCalendar, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocationType.Factory

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION

Constructor Summary

Constructors

Constructor	Description
LocationType()	Default constructor.
LocationType(String aValue)
LocationType(LocationType... locationTypes)
LocationType(LocationTypeList cList)
LocationType(ParameterList aList, String aValue)
LocationType(ParameterList params, LocationType... locationTypes)
LocationType(ParameterList aList, LocationTypeList cList)

Method Summary

Modifier and Type	Method	Description
LocationTypeList	getLocationTypes()
String	getValue()
void	setValue(String aValue)	Sets the current value of the property.
void	validate()	Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.Property

compareTo, copy, equals, getName, getParameter, getParameters, getParameters, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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(LocationTypeList cList)

Parameters:

cList - a list of locationTypes

LocationType

public LocationType(ParameterList aList,
                    LocationTypeList 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 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

getLocationTypes

public final LocationTypeList getLocationTypes()

Returns:

Returns the locationTypes.

getValue

public final String getValue()

Specified by:

getValue in class Content

Returns:

the content value

validate

public void 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