Caldavsync Sources / annotate

src/net/fortuna/ical4j/model/property/Location.java@fb9019fb1bf7 (annotated)

src/net/fortuna/ical4j/model/property/Location.java

Tue, 10 Feb 2015 18:12:00 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 10 Feb 2015 18:12:00 +0100
changeset 0
fb9019fb1bf7
permissions
-rw-r--r--

Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.

michael@0 1 /**
michael@0 2 * Copyright (c) 2012, Ben Fortuna
michael@0 3 * All rights reserved.
michael@0 4 *
michael@0 5 * Redistribution and use in source and binary forms, with or without
michael@0 6 * modification, are permitted provided that the following conditions
michael@0 7 * are met:
michael@0 8 *
michael@0 9 * o Redistributions of source code must retain the above copyright
michael@0 10 * notice, this list of conditions and the following disclaimer.
michael@0 11 *
michael@0 12 * o Redistributions in binary form must reproduce the above copyright
michael@0 13 * notice, this list of conditions and the following disclaimer in the
michael@0 14 * documentation and/or other materials provided with the distribution.
michael@0 15 *
michael@0 16 * o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0 17 * may be used to endorse or promote products derived from this software
michael@0 18 * without specific prior written permission.
michael@0 19 *
michael@0 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0 23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0 31 */
michael@0 32 package net.fortuna.ical4j.model.property;
michael@0 33
michael@0 34 import net.fortuna.ical4j.model.Escapable;
michael@0 35 import net.fortuna.ical4j.model.Parameter;
michael@0 36 import net.fortuna.ical4j.model.ParameterList;
michael@0 37 import net.fortuna.ical4j.model.Property;
michael@0 38 import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0 39 import net.fortuna.ical4j.model.ValidationException;
michael@0 40 import net.fortuna.ical4j.util.ParameterValidator;
michael@0 41
michael@0 42 /**
michael@0 43 * $Id$
michael@0 44 *
michael@0 45 * Created: [Apr 6, 2004]
michael@0 46 *
michael@0 47 * Defines a LOCATION iCalendar component property.
michael@0 48 *
michael@0 49 * <pre>
michael@0 50 * 4.8.1.7 Location
michael@0 51 *
michael@0 52 * Property Name: LOCATION
michael@0 53 *
michael@0 54 * Purpose: The property defines the intended venue for the activity
michael@0 55 * defined by a calendar component.
michael@0 56 *
michael@0 57 * Value Type: TEXT
michael@0 58 *
michael@0 59 * Property Parameters: Non-standard, alternate text representation and
michael@0 60 * language property parameters can be specified on this property.
michael@0 61 *
michael@0 62 * Conformance: This property can be specified in &quot;VEVENT&quot; or &quot;VTODO&quot;
michael@0 63 * calendar component.
michael@0 64 *
michael@0 65 * Description: Specific venues such as conference or meeting rooms may
michael@0 66 * be explicitly specified using this property. An alternate
michael@0 67 * representation may be specified that is a URI that points to
michael@0 68 * directory information with more structured specification of the
michael@0 69 * location. For example, the alternate representation may specify
michael@0 70 * either an LDAP URI pointing to an LDAP server entry or a CID URI
michael@0 71 * pointing to a MIME body part containing a vCard [RFC 2426] for the
michael@0 72 * location.
michael@0 73 *
michael@0 74 * Format Definition: The property is defined by the following notation:
michael@0 75 *
michael@0 76 * location = &quot;LOCATION locparam &quot;:&quot; text CRLF
michael@0 77 *
michael@0 78 * locparam = *(
michael@0 79 *
michael@0 80 * ; the following are optional,
michael@0 81 * ; but MUST NOT occur more than once
michael@0 82 *
michael@0 83 * (&quot;;&quot; altrepparam) / (&quot;;&quot; languageparam) /
michael@0 84 *
michael@0 85 * ; the following is optional,
michael@0 86 * ; and MAY occur more than once
michael@0 87 *
michael@0 88 * (&quot;;&quot; xparam)
michael@0 89 *
michael@0 90 * )
michael@0 91 *
michael@0 92 * Example: The following are some examples of this property:
michael@0 93 *
michael@0 94 * LOCATION:Conference Room - F123, Bldg. 002
michael@0 95 *
michael@0 96 * LOCATION;ALTREP=&quot;http://xyzcorp.com/conf-rooms/f123.vcf&quot;:
michael@0 97 * Conference Room - F123, Bldg. 002
michael@0 98 * </pre>
michael@0 99 *
michael@0 100 * @author Ben Fortuna
michael@0 101 */
michael@0 102 public class Location extends Property implements Escapable {
michael@0 103
michael@0 104 private static final long serialVersionUID = 8651881536125682401L;
michael@0 105
michael@0 106 private String value;
michael@0 107
michael@0 108 /**
michael@0 109 * Default constructor.
michael@0 110 */
michael@0 111 public Location() {
michael@0 112 super(LOCATION, PropertyFactoryImpl.getInstance());
michael@0 113 }
michael@0 114
michael@0 115 /**
michael@0 116 * @param aValue a value string for this component
michael@0 117 */
michael@0 118 public Location(final String aValue) {
michael@0 119 super(LOCATION, PropertyFactoryImpl.getInstance());
michael@0 120 setValue(aValue);
michael@0 121 }
michael@0 122
michael@0 123 /**
michael@0 124 * @param aList a list of parameters for this component
michael@0 125 * @param aValue a value string for this component
michael@0 126 */
michael@0 127 public Location(final ParameterList aList, final String aValue) {
michael@0 128 super(LOCATION, aList, PropertyFactoryImpl.getInstance());
michael@0 129 setValue(aValue);
michael@0 130 }
michael@0 131
michael@0 132 /**
michael@0 133 * {@inheritDoc}
michael@0 134 */
michael@0 135 public final void validate() throws ValidationException {
michael@0 136
michael@0 137 /*
michael@0 138 * ; the following are optional, ; but MUST NOT occur more than once (";" altrepparam) / (";" languageparam) /
michael@0 139 */
michael@0 140 ParameterValidator.getInstance().assertOneOrLess(Parameter.ALTREP,
michael@0 141 getParameters());
michael@0 142 ParameterValidator.getInstance().assertOneOrLess(Parameter.LANGUAGE,
michael@0 143 getParameters());
michael@0 144 ParameterValidator.getInstance().assertOneOrLess(Parameter.VVENUE,
michael@0 145 getParameters());
michael@0 146
michael@0 147 /*
michael@0 148 * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0 149 */
michael@0 150 }
michael@0 151
michael@0 152 /**
michael@0 153 * {@inheritDoc}
michael@0 154 */
michael@0 155 public final void setValue(final String aValue) {
michael@0 156 this.value = aValue;
michael@0 157 }
michael@0 158
michael@0 159 /**
michael@0 160 * {@inheritDoc}
michael@0 161 */
michael@0 162 public final String getValue() {
michael@0 163 return value;
michael@0 164 }
michael@0 165 }

Mercurial Repository: Caldavsync Sources

Europalab SCM Repository Server

mercurial