Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class TzId

extends Property
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.validate.ValidationException, .ValidationResult, net.fortuna.ical4j.validate.property.TimeZonePropertyValidators

$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
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final String
PREFIX

Timezone identifier prefix.

private static final long
private String
Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
TzId()

Default constructor.

public
TzId(final String
a value string for this component
aValue
)

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

Method Summary

Modifier and TypeMethod and Description
public final String
protected PropertyFactory<TzId>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

PREFIXback to summary
public static final String PREFIX

Timezone identifier prefix.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

valueback to summary
private String value

Constructor Detail

TzIdback to summary
public TzId()

Default constructor.

TzIdback to summary
public TzId(final String aValue)
Parameters
aValue:String

a value string for this component

TzIdback to summary
public TzId(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

Method Detail

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<TzId> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<TzId>

a property factory instance

Annotations
@Override
setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class TzId.Factory

extends Factory
implements PropertyFactory<TzId>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public TzId
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public TzId
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public TzId createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:TzId

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public TzId createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:TzId

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override