Class TzId
java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Property
net.fortuna.ical4j.model.property.TzId
- All Implemented Interfaces:
Serializable,Comparable<Property>,Encodable,FluentProperty
$Id$
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
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsFields inherited from class net.fortuna.ical4j.model.Property
ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALENDAR_ADDRESS, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PARTICIPANT_TYPE, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, PROXIMITY, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCE_TYPE, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, STRUCTURED_DATA, STYLED_DESCRIPTION, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZID_ALIAS_OF, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZUNTIL, TZURL, UID, URL, VERSION, XML -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class net.fortuna.ical4j.model.Property
compareTo, copy, equals, getFluentTarget, getName, getParameter, getParameters, getParameters, hashCode, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.fortuna.ical4j.model.FluentProperty
withParameter
-
Field Details
-
PREFIX
Timezone identifier prefix.- See Also:
-
-
Constructor Details
-
TzId
public TzId()Default constructor. -
TzId
- Parameters:
aValue- a value string for this component
-
TzId
- Parameters:
aList- a list of parameters for this componentaValue- a value string for this component
-
-
Method Details
-
setValue
Sets the current value of the property. -
getValue
-
validate
Description copied from class:PropertyPerform validation on a property.- Specified by:
validatein classProperty- Throws:
ValidationException- where the property is not in a valid state
-