1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/Location.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,165 @@
1.4 +/**
1.5 + * Copyright (c) 2012, Ben Fortuna
1.6 + * All rights reserved.
1.7 + *
1.8 + * Redistribution and use in source and binary forms, with or without
1.9 + * modification, are permitted provided that the following conditions
1.10 + * are met:
1.11 + *
1.12 + * o Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * o Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.34 + */
1.35 +package net.fortuna.ical4j.model.property;
1.36 +
1.37 +import net.fortuna.ical4j.model.Escapable;
1.38 +import net.fortuna.ical4j.model.Parameter;
1.39 +import net.fortuna.ical4j.model.ParameterList;
1.40 +import net.fortuna.ical4j.model.Property;
1.41 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
1.42 +import net.fortuna.ical4j.model.ValidationException;
1.43 +import net.fortuna.ical4j.util.ParameterValidator;
1.44 +
1.45 +/**
1.46 + * $Id$
1.47 + *
1.48 + * Created: [Apr 6, 2004]
1.49 + *
1.50 + * Defines a LOCATION iCalendar component property.
1.51 + *
1.52 + * <pre>
1.53 + * 4.8.1.7 Location
1.54 + *
1.55 + * Property Name: LOCATION
1.56 + *
1.57 + * Purpose: The property defines the intended venue for the activity
1.58 + * defined by a calendar component.
1.59 + *
1.60 + * Value Type: TEXT
1.61 + *
1.62 + * Property Parameters: Non-standard, alternate text representation and
1.63 + * language property parameters can be specified on this property.
1.64 + *
1.65 + * Conformance: This property can be specified in "VEVENT" or "VTODO"
1.66 + * calendar component.
1.67 + *
1.68 + * Description: Specific venues such as conference or meeting rooms may
1.69 + * be explicitly specified using this property. An alternate
1.70 + * representation may be specified that is a URI that points to
1.71 + * directory information with more structured specification of the
1.72 + * location. For example, the alternate representation may specify
1.73 + * either an LDAP URI pointing to an LDAP server entry or a CID URI
1.74 + * pointing to a MIME body part containing a vCard [RFC 2426] for the
1.75 + * location.
1.76 + *
1.77 + * Format Definition: The property is defined by the following notation:
1.78 + *
1.79 + * location = "LOCATION locparam ":" text CRLF
1.80 + *
1.81 + * locparam = *(
1.82 + *
1.83 + * ; the following are optional,
1.84 + * ; but MUST NOT occur more than once
1.85 + *
1.86 + * (";" altrepparam) / (";" languageparam) /
1.87 + *
1.88 + * ; the following is optional,
1.89 + * ; and MAY occur more than once
1.90 + *
1.91 + * (";" xparam)
1.92 + *
1.93 + * )
1.94 + *
1.95 + * Example: The following are some examples of this property:
1.96 + *
1.97 + * LOCATION:Conference Room - F123, Bldg. 002
1.98 + *
1.99 + * LOCATION;ALTREP="http://xyzcorp.com/conf-rooms/f123.vcf":
1.100 + * Conference Room - F123, Bldg. 002
1.101 + * </pre>
1.102 + *
1.103 + * @author Ben Fortuna
1.104 + */
1.105 +public class Location extends Property implements Escapable {
1.106 +
1.107 + private static final long serialVersionUID = 8651881536125682401L;
1.108 +
1.109 + private String value;
1.110 +
1.111 + /**
1.112 + * Default constructor.
1.113 + */
1.114 + public Location() {
1.115 + super(LOCATION, PropertyFactoryImpl.getInstance());
1.116 + }
1.117 +
1.118 + /**
1.119 + * @param aValue a value string for this component
1.120 + */
1.121 + public Location(final String aValue) {
1.122 + super(LOCATION, PropertyFactoryImpl.getInstance());
1.123 + setValue(aValue);
1.124 + }
1.125 +
1.126 + /**
1.127 + * @param aList a list of parameters for this component
1.128 + * @param aValue a value string for this component
1.129 + */
1.130 + public Location(final ParameterList aList, final String aValue) {
1.131 + super(LOCATION, aList, PropertyFactoryImpl.getInstance());
1.132 + setValue(aValue);
1.133 + }
1.134 +
1.135 + /**
1.136 + * {@inheritDoc}
1.137 + */
1.138 + public final void validate() throws ValidationException {
1.139 +
1.140 + /*
1.141 + * ; the following are optional, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) /
1.142 + */
1.143 + ParameterValidator.getInstance().assertOneOrLess(Parameter.ALTREP,
1.144 + getParameters());
1.145 + ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE,
1.146 + getParameters());
1.147 + ParameterValidator.getInstance().assertOneOrLess(Parameter.VVENUE,
1.148 + getParameters());
1.149 +
1.150 + /*
1.151 + * ; the following is optional, ; and MAY occur more than once (";" xparam)
1.152 + */
1.153 + }
1.154 +
1.155 + /**
1.156 + * {@inheritDoc}
1.157 + */
1.158 + public final void setValue(final String aValue) {
1.159 + this.value = aValue;
1.160 + }
1.161 +
1.162 + /**
1.163 + * {@inheritDoc}
1.164 + */
1.165 + public final String getValue() {
1.166 + return value;
1.167 + }
1.168 +}
