net.fortuna.ical4j.model.property

Class TzId

Implemented Interfaces:
Escapable

public class TzId
extends Property
implements Escapable

$Id: TzId.java,v 1.12 2008/12/16 12:34:51 fortuna Exp $ Created: [Apr 6, 2004] Defines a TZID iCalendar component property.
     4.8.3.1 Time Zone Identifier
     
        Property Name: TZID
     
        Purpose: This property specifies the text value that uniquely
        identifies the "VTIMEZONE" calendar component.
     
        Value Type: TEXT
     
        Property Parameters: Non-standard property parameters can be
        specified on this property.
     
        Conformance: This property MUST be specified in a "VTIMEZONE"
        calendar component.
     
        Description: This is the label by which a time zone calendar
        component is referenced by any iCalendar properties whose data type
        is either DATE-TIME or TIME and not intended to specify a UTC or a
        "floating" time. The presence of the SOLIDUS character (US-ASCII
        decimal 47) as a prefix, indicates that this TZID represents an
        unique ID in a globally defined time zone registry (when such
        registry is defined).
     
             Note: This document does not define a naming convention for time
             zone identifiers. Implementers may want to use the naming
             conventions defined in existing time zone specifications such as
             the public-domain Olson database [TZ]. The specification of
             globally unique time zone identifiers is not addressed by this
             document and is left for future study.
     
        Format Definition: This property is defined by the following
        notation:
     
          tzid       = "TZID" tzidpropparam ":" [tzidprefix] text CRLF
     
          tzidpropparam      = *(";" xparam)
     
          ;tzidprefix        = "/"
          ; Defined previously. Just listed here for reader convenience.
     
        Example: The following are examples of non-globally unique time zone
        identifiers:
     
          TZID:US-Eastern
     
          TZID:California-Los_Angeles
     
        The following is an example of a fictitious globally unique time zone
        identifier:
     
          TZID:/US-New_York-New_York
 

Field Summary

static String
PREFIX

Constructor Summary

TzId()
Default constructor.
TzId(ParameterList aList, String aValue)
TzId(String aValue)

Method Summary

String
getValue()
void
setValue(String aValue)
void
validate()

Field Details

PREFIX

public static final String PREFIX

Constructor Details

TzId

public TzId()
Default constructor.

TzId

public TzId(ParameterList aList,
            String aValue)
Parameters:
aList - a list of parameters for this component
aValue - a value string for this component

TzId

public TzId(String aValue)
Parameters:
aValue - a value string for this component

Method Details

getValue

public final String getValue()

setValue

public final void setValue(String aValue)

validate

public final void validate()
            throws ValidationException