Package net.fortuna.ical4j.model.property

Class Location

java.lang.Object

net.fortuna.ical4j.model.Content

net.fortuna.ical4j.model.Property

net.fortuna.ical4j.model.property.Location

All Implemented Interfaces:

Serializable, Comparable<Property>, Encodable, FluentProperty

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Location.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, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION

Constructor Summary

Constructors

Constructor	Description
Location()	Default constructor.
Location(String aValue)
Location(ParameterList aList, String aValue)

Method Summary

Modifier and Type	Method	Description
String	getValue()
protected PropertyFactory<Location>	newFactory()	Returns a new property factory used to create deep copies.
void	setValue(String aValue)	Sets the current value of the property.
ValidationResult	validate()	Perform validation on a property.

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

add, compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameterList, getParameters, getRequiredParameter, hashCode, remove, removeAll, replace, setParameters, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.FluentProperty

withParameter

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

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