michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import net.fortuna.ical4j.model.Escapable;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.Property;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: import net.fortuna.ical4j.model.ValidationException;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines a TZID iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.3.1 Time Zone Identifier
michael@0:  *     
michael@0:  *        Property Name: TZID
michael@0:  *     
michael@0:  *        Purpose: This property specifies the text value that uniquely
michael@0:  *        identifies the &quot;VTIMEZONE&quot; calendar component.
michael@0:  *     
michael@0:  *        Value Type: TEXT
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard property parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Conformance: This property MUST be specified in a &quot;VTIMEZONE&quot;
michael@0:  *        calendar component.
michael@0:  *     
michael@0:  *        Description: This is the label by which a time zone calendar
michael@0:  *        component is referenced by any iCalendar properties whose data type
michael@0:  *        is either DATE-TIME or TIME and not intended to specify a UTC or a
michael@0:  *        &quot;floating&quot; time. The presence of the SOLIDUS character (US-ASCII
michael@0:  *        decimal 47) as a prefix, indicates that this TZID represents an
michael@0:  *        unique ID in a globally defined time zone registry (when such
michael@0:  *        registry is defined).
michael@0:  *     
michael@0:  *             Note: This document does not define a naming convention for time
michael@0:  *             zone identifiers. Implementers may want to use the naming
michael@0:  *             conventions defined in existing time zone specifications such as
michael@0:  *             the public-domain Olson database [TZ]. The specification of
michael@0:  *             globally unique time zone identifiers is not addressed by this
michael@0:  *             document and is left for future study.
michael@0:  *     
michael@0:  *        Format Definition: This property is defined by the following
michael@0:  *        notation:
michael@0:  *     
michael@0:  *          tzid       = &quot;TZID&quot; tzidpropparam &quot;:&quot; [tzidprefix] text CRLF
michael@0:  *     
michael@0:  *          tzidpropparam      = *(&quot;;&quot; xparam)
michael@0:  *     
michael@0:  *          ;tzidprefix        = &quot;/&quot;
michael@0:  *          ; Defined previously. Just listed here for reader convenience.
michael@0:  *     
michael@0:  *        Example: The following are examples of non-globally unique time zone
michael@0:  *        identifiers:
michael@0:  *     
michael@0:  *          TZID:US-Eastern
michael@0:  *     
michael@0:  *          TZID:California-Los_Angeles
michael@0:  *     
michael@0:  *        The following is an example of a fictitious globally unique time zone
michael@0:  *        identifier:
michael@0:  *     
michael@0:  *          TZID:/US-New_York-New_York
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class TzId extends Property implements Escapable {
michael@0: 
michael@0:     private static final long serialVersionUID = -522764921502407137L;
michael@0: 
michael@0:     /**
michael@0:      * Timezone identifier prefix.
michael@0:      */
michael@0:     public static final String PREFIX = "/";
michael@0: 
michael@0:     private String value;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      */
michael@0:     public TzId() {
michael@0:         super(TZID, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public TzId(final String aValue) {
michael@0:         super(TZID, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      */
michael@0:     public TzId(final ParameterList aList, final String aValue) {
michael@0:         super(TZID, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void setValue(final String aValue) {
michael@0:         this.value = aValue;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final String getValue() {
michael@0:         return value;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * {@inheritDoc}
michael@0:      */
michael@0:     public final void validate() throws ValidationException {
michael@0:         // TODO: Auto-generated method stub
michael@0:     }
michael@0: }