• file
• revisions
• annotate
• diff
• comparison
• raw

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

src/net/fortuna/ical4j/model/property/TzId.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.ParameterList;
michael@0	36	import net.fortuna.ical4j.model.Property;
michael@0	37	import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0	38	import net.fortuna.ical4j.model.ValidationException;
michael@0	39
michael@0	40	/**
michael@0	41	* $Id$
michael@0	42	*
michael@0	43	* Created: [Apr 6, 2004]
michael@0	44	*
michael@0	45	* Defines a TZID iCalendar component property.
michael@0	46	*
michael@0	47	* <pre>
michael@0	48	* 4.8.3.1 Time Zone Identifier
michael@0	49	*
michael@0	50	* Property Name: TZID
michael@0	51	*
michael@0	52	* Purpose: This property specifies the text value that uniquely
michael@0	53	* identifies the &quot;VTIMEZONE&quot; calendar component.
michael@0	54	*
michael@0	55	* Value Type: TEXT
michael@0	56	*
michael@0	57	* Property Parameters: Non-standard property parameters can be
michael@0	58	* specified on this property.
michael@0	59	*
michael@0	60	* Conformance: This property MUST be specified in a &quot;VTIMEZONE&quot;
michael@0	61	* calendar component.
michael@0	62	*
michael@0	63	* Description: This is the label by which a time zone calendar
michael@0	64	* component is referenced by any iCalendar properties whose data type
michael@0	65	* is either DATE-TIME or TIME and not intended to specify a UTC or a
michael@0	66	* &quot;floating&quot; time. The presence of the SOLIDUS character (US-ASCII
michael@0	67	* decimal 47) as a prefix, indicates that this TZID represents an
michael@0	68	* unique ID in a globally defined time zone registry (when such
michael@0	69	* registry is defined).
michael@0	70	*
michael@0	71	* Note: This document does not define a naming convention for time
michael@0	72	* zone identifiers. Implementers may want to use the naming
michael@0	73	* conventions defined in existing time zone specifications such as
michael@0	74	* the public-domain Olson database [TZ]. The specification of
michael@0	75	* globally unique time zone identifiers is not addressed by this
michael@0	76	* document and is left for future study.
michael@0	77	*
michael@0	78	* Format Definition: This property is defined by the following
michael@0	79	* notation:
michael@0	80	*
michael@0	81	* tzid = &quot;TZID&quot; tzidpropparam &quot;:&quot; [tzidprefix] text CRLF
michael@0	82	*
michael@0	83	* tzidpropparam = *(&quot;;&quot; xparam)
michael@0	84	*
michael@0	85	* ;tzidprefix = &quot;/&quot;
michael@0	86	* ; Defined previously. Just listed here for reader convenience.
michael@0	87	*
michael@0	88	* Example: The following are examples of non-globally unique time zone
michael@0	89	* identifiers:
michael@0	90	*
michael@0	91	* TZID:US-Eastern
michael@0	92	*
michael@0	93	* TZID:California-Los_Angeles
michael@0	94	*
michael@0	95	* The following is an example of a fictitious globally unique time zone
michael@0	96	* identifier:
michael@0	97	*
michael@0	98	* TZID:/US-New_York-New_York
michael@0	99	* </pre>
michael@0	100	*
michael@0	101	* @author Ben Fortuna
michael@0	102	*/
michael@0	103	public class TzId extends Property implements Escapable {
michael@0	104
michael@0	105	private static final long serialVersionUID = -522764921502407137L;
michael@0	106
michael@0	107	/**
michael@0	108	* Timezone identifier prefix.
michael@0	109	*/
michael@0	110	public static final String PREFIX = "/";
michael@0	111
michael@0	112	private String value;
michael@0	113
michael@0	114	/**
michael@0	115	* Default constructor.
michael@0	116	*/
michael@0	117	public TzId() {
michael@0	118	super(TZID, PropertyFactoryImpl.getInstance());
michael@0	119	}
michael@0	120
michael@0	121	/**
michael@0	122	* @param aValue a value string for this component
michael@0	123	*/
michael@0	124	public TzId(final String aValue) {
michael@0	125	super(TZID, PropertyFactoryImpl.getInstance());
michael@0	126	setValue(aValue);
michael@0	127	}
michael@0	128
michael@0	129	/**
michael@0	130	* @param aList a list of parameters for this component
michael@0	131	* @param aValue a value string for this component
michael@0	132	*/
michael@0	133	public TzId(final ParameterList aList, final String aValue) {
michael@0	134	super(TZID, aList, PropertyFactoryImpl.getInstance());
michael@0	135	setValue(aValue);
michael@0	136	}
michael@0	137
michael@0	138	/**
michael@0	139	* {@inheritDoc}
michael@0	140	*/
michael@0	141	public final void setValue(final String aValue) {
michael@0	142	this.value = aValue;
michael@0	143	}
michael@0	144
michael@0	145	/**
michael@0	146	* {@inheritDoc}
michael@0	147	*/
michael@0	148	public final String getValue() {
michael@0	149	return value;
michael@0	150	}
michael@0	151
michael@0	152	/**
michael@0	153	* {@inheritDoc}
michael@0	154	*/
michael@0	155	public final void validate() throws ValidationException {
michael@0	156	// TODO: Auto-generated method stub
michael@0	157	}
michael@0	158	}