1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/TzId.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,158 @@
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.ParameterList;
1.39 +import net.fortuna.ical4j.model.Property;
1.40 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
1.41 +import net.fortuna.ical4j.model.ValidationException;
1.42 +
1.43 +/**
1.44 + * $Id$
1.45 + *
1.46 + * Created: [Apr 6, 2004]
1.47 + *
1.48 + * Defines a TZID iCalendar component property.
1.49 + *
1.50 + * <pre>
1.51 + * 4.8.3.1 Time Zone Identifier
1.52 + *
1.53 + * Property Name: TZID
1.54 + *
1.55 + * Purpose: This property specifies the text value that uniquely
1.56 + * identifies the "VTIMEZONE" calendar component.
1.57 + *
1.58 + * Value Type: TEXT
1.59 + *
1.60 + * Property Parameters: Non-standard property parameters can be
1.61 + * specified on this property.
1.62 + *
1.63 + * Conformance: This property MUST be specified in a "VTIMEZONE"
1.64 + * calendar component.
1.65 + *
1.66 + * Description: This is the label by which a time zone calendar
1.67 + * component is referenced by any iCalendar properties whose data type
1.68 + * is either DATE-TIME or TIME and not intended to specify a UTC or a
1.69 + * "floating" time. The presence of the SOLIDUS character (US-ASCII
1.70 + * decimal 47) as a prefix, indicates that this TZID represents an
1.71 + * unique ID in a globally defined time zone registry (when such
1.72 + * registry is defined).
1.73 + *
1.74 + * Note: This document does not define a naming convention for time
1.75 + * zone identifiers. Implementers may want to use the naming
1.76 + * conventions defined in existing time zone specifications such as
1.77 + * the public-domain Olson database [TZ]. The specification of
1.78 + * globally unique time zone identifiers is not addressed by this
1.79 + * document and is left for future study.
1.80 + *
1.81 + * Format Definition: This property is defined by the following
1.82 + * notation:
1.83 + *
1.84 + * tzid = "TZID" tzidpropparam ":" [tzidprefix] text CRLF
1.85 + *
1.86 + * tzidpropparam = *(";" xparam)
1.87 + *
1.88 + * ;tzidprefix = "/"
1.89 + * ; Defined previously. Just listed here for reader convenience.
1.90 + *
1.91 + * Example: The following are examples of non-globally unique time zone
1.92 + * identifiers:
1.93 + *
1.94 + * TZID:US-Eastern
1.95 + *
1.96 + * TZID:California-Los_Angeles
1.97 + *
1.98 + * The following is an example of a fictitious globally unique time zone
1.99 + * identifier:
1.100 + *
1.101 + * TZID:/US-New_York-New_York
1.102 + * </pre>
1.103 + *
1.104 + * @author Ben Fortuna
1.105 + */
1.106 +public class TzId extends Property implements Escapable {
1.107 +
1.108 + private static final long serialVersionUID = -522764921502407137L;
1.109 +
1.110 + /**
1.111 + * Timezone identifier prefix.
1.112 + */
1.113 + public static final String PREFIX = "/";
1.114 +
1.115 + private String value;
1.116 +
1.117 + /**
1.118 + * Default constructor.
1.119 + */
1.120 + public TzId() {
1.121 + super(TZID, PropertyFactoryImpl.getInstance());
1.122 + }
1.123 +
1.124 + /**
1.125 + * @param aValue a value string for this component
1.126 + */
1.127 + public TzId(final String aValue) {
1.128 + super(TZID, PropertyFactoryImpl.getInstance());
1.129 + setValue(aValue);
1.130 + }
1.131 +
1.132 + /**
1.133 + * @param aList a list of parameters for this component
1.134 + * @param aValue a value string for this component
1.135 + */
1.136 + public TzId(final ParameterList aList, final String aValue) {
1.137 + super(TZID, aList, PropertyFactoryImpl.getInstance());
1.138 + setValue(aValue);
1.139 + }
1.140 +
1.141 + /**
1.142 + * {@inheritDoc}
1.143 + */
1.144 + public final void setValue(final String aValue) {
1.145 + this.value = aValue;
1.146 + }
1.147 +
1.148 + /**
1.149 + * {@inheritDoc}
1.150 + */
1.151 + public final String getValue() {
1.152 + return value;
1.153 + }
1.154 +
1.155 + /**
1.156 + * {@inheritDoc}
1.157 + */
1.158 + public final void validate() throws ValidationException {
1.159 + // TODO: Auto-generated method stub
1.160 + }
1.161 +}
