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

public Class TzId

extends Parameter
implements Encodable
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.Encodable
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.util.Strings, java.time.ZoneId, .DateTimeException
$Id$ [18-Apr-2004] Defines a Time Zone Identifier parameter.
Author
benfortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
TzId.Factory

Field Summary

Modifier and TypeField and Description
public static final String
PREFIX

Timezone identifier prefix.

private static final long
serialVersionUID

Hides net.fortuna.ical4j.model.Parameter.serialVersionUID.

private final String
value

Inherited from net.fortuna.ical4j.model.Parameter:
ABBREVALTREPCNCUTYPEDELEGATED_FROMDELEGATED_TODERIVEDDIRDISPLAYEMAILENCODINGEXPERIMENTAL_PREFIXFBTYPEFEATUREFMTTYPELABELLANGUAGEMEMBERORDERPARTSTATRANGERELATEDRELTYPEROLERSVPSCHEDULE_AGENTSCHEDULE_STATUSSCHEMASENT_BYTYPETZIDVALUEVVENUE

Constructor Summary

AccessConstructor and Description
public
TzId(final String
a string representation of a time zone identifier
aValue)

Method Summary

Modifier and TypeMethod and Description
public final String
getValue()

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

public ZoneId

Returns:

a zone id represented by this instance
toZoneId()

Provides a ZoneId representation of this instance.

public ZoneId
toZoneId(TimeZoneRegistry timeZoneRegistry)

Inherited from net.fortuna.ical4j.model.Parameter:
compareToequalsgetNamehashCodetoString

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.Parameter.serialVersionUID.

valueback to summary
private final String value

Constructor Detail

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

a string representation of a time zone identifier

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
toZoneIdback to summary
public ZoneId toZoneId()

Provides a ZoneId representation of this instance. If created with a local timezone registry the returned value will provide the corresponding globally unique value.

Returns:ZoneId

a zone id represented by this instance

toZoneIdback to summary
public ZoneId toZoneId(TimeZoneRegistry timeZoneRegistry)
net.fortuna.ical4j.model.parameter back to summary

public Class TzId.Factory

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

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
public
Factory()

Method Summary

Modifier and TypeMethod and Description
public TzId
createParameter(final String
a value to assign to the returned parameter
value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

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

createParameterback to summary
public TzId createParameter(final String value)

Implements net.fortuna.ical4j.model.ParameterFactory.createParameter.

Doc from net.fortuna.ical4j.model.ParameterFactory.createParameter.

Returns a parameter instance of the appropriate type with the specified value.

Parameters
value:String

a value to assign to the returned parameter

Returns:TzId

a parameter instance, or null if this factory is unable to create an appropriate parameter

Annotations
@Override