ezvcard.types
Class TimezoneType

java.lang.Object
  ezvcard.types.VCardType
      ezvcard.types.TimezoneType

All Implemented Interfaces:

Comparable<VCardType>

public class TimezoneType
extends VCardType

Contains the timezone that the person lives/works in.

 VCard vcard = new VCard();
 TimezoneType tz = new TimezoneType(-5, 0, "America/New_York");
 vcard.addTimezone(tz);
 

vCard property name: TZ

vCard versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

Field Summary

static String

NAME

Fields inherited from class ezvcard.types.VCardType

group, subTypes, typeName

Constructor Summary

TimezoneType()

TimezoneType(Integer hourOffset, Integer minuteOffset)
This is the recommended constructor for version 2.1 and 3.0 vCards.

TimezoneType(Integer hourOffset, Integer minuteOffset, String text)
This constructor can be used for all vCard versions.

TimezoneType(String text)
This is the recommended constructor for version 4.0 vCards.

Method Summary

void	addPid(int localId, int clientPidMapRef) Adds a PID value.
protected void	doMarshalSubTypes(VCardSubTypes copy, VCardVersion version, List<String> warnings, CompatibilityMode compatibilityMode, VCard vcard) Gets the sub types that will be sent over the wire.
protected void	doMarshalText(StringBuilder sb, VCardVersion version, List<String> warnings, CompatibilityMode compatibilityMode) Converts this type object to a string for sending over the wire.
protected void	doMarshalXml(XCardElement parent, List<String> warnings, CompatibilityMode compatibilityMode) Marshals this type for inclusion in an xCard (XML document).
protected void	doUnmarshalHtml(HCardElement element, List<String> warnings) Unmarshals the type from an hCard (HTML document).
protected void	doUnmarshalText(String value, VCardVersion version, List<String> warnings, CompatibilityMode compatibilityMode) Unmarshals the type value from off the wire.
protected void	doUnmarshalXml(XCardElement element, List<String> warnings, CompatibilityMode compatibilityMode) Unmarshals the type from an xCard (XML document).
String	getAltId() Gets the ALTID.
Integer	getHourOffset() Gets the hour offset.
String	getMediaType() Gets the MEDIATYPE parameter.
Integer	getMinuteOffset() Gets the minute offset.
List<Integer[]>	getPids() Gets all PID parameter values.
Integer	getPref() Gets the preference value.
String	getText() Gets the text portion of the timezone.
String	getType() Gets the TYPE parameter.
void	removePids() Removes all PID values.
void	setAltId(String altId) Sets the ALTID.
void	setHourOffset(Integer hourOffset) Sets the hour offset.
void	setMediaType(String mediaType) Sets the MEDIATYPE parameter.
void	setMinuteOffset(Integer minuteOffset) Sets the minute offset.
void	setPref(Integer pref) Sets the preference value.
void	setText(String text) Sets the text portion of the timezone.
void	setType(String type) Sets the TYPE parameter.
TimeZone	toTimeZone() Creates a TimeZone representation of this class.

Methods inherited from class ezvcard.types.VCardType

compareTo, getGroup, getQName, getSubTypes, getSupportedVersions, getTypeName, marshalSubTypes, marshalText, marshalXml, setGroup, unmarshalHtml, unmarshalText, unmarshalXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

TimezoneType

public TimezoneType()

TimezoneType

public TimezoneType(String text)

This is the recommended constructor for version 4.0 vCards.

Parameters:

text - string representing the timezone from the Olson Database (e.g. "America/New_York")

TimezoneType

public TimezoneType(Integer hourOffset,
                    Integer minuteOffset)

This is the recommended constructor for version 2.1 and 3.0 vCards.

Parameters:

hourOffset - the hour offset

minuteOffset - the minute offset

TimezoneType

public TimezoneType(Integer hourOffset,
                    Integer minuteOffset,
                    String text)

This constructor can be used for all vCard versions.

Parameters:

hourOffset - the hour offset

minuteOffset - the minute offset

text - can be anything, but should be a string representing the timezone from the Olson Database (e.g. "America/New_York")

Method Detail

getHourOffset

public Integer getHourOffset()

Gets the hour offset.

Returns:

the hour offset or null if not set

setHourOffset

public void setHourOffset(Integer hourOffset)

Sets the hour offset.

Parameters:

hourOffset - the hour offset or null to remove

getMinuteOffset

public Integer getMinuteOffset()

Gets the minute offset.

Returns:

the minute offset or null if not set

setMinuteOffset

public void setMinuteOffset(Integer minuteOffset)

Sets the minute offset.

Parameters:

minuteOffset - the minute offset or null to remove

Throws:

IllegalArgumentException - if the minute offset is not between 0 and 59

getText

public String getText()

Gets the text portion of the timezone.

Returns:

the text portion (e.g. "America/New_York")

setText

public void setText(String text)

Sets the text portion of the timezone.

Parameters:

text - the text portion (e.g. "America/New_York")

toTimeZone

public TimeZone toTimeZone()

Creates a TimeZone representation of this class.

Returns:

a TimeZone object or null if this object contains no offset data

getType

public String getType()

Gets the TYPE parameter.

vCard versions: 4.0

Returns:

the TYPE value (typically, this will be either "work" or "home") or null if it doesn't exist

setType

public void setType(String type)

Sets the TYPE parameter.

vCard versions: 4.0

Parameters:

type - the TYPE value (this should be either "work" or "home") or null to remove

getMediaType

public String getMediaType()

Gets the MEDIATYPE parameter.

vCard versions: 4.0

Returns:

the media type or null if not set

setMediaType

public void setMediaType(String mediaType)

Sets the MEDIATYPE parameter.

vCard versions: 4.0

Parameters:

mediaType - the media type or null to remove

getPids

public List<Integer[]> getPids()

Gets all PID parameter values.

vCard versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardSubTypes.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Adds a PID value.

vCard versions: 4.0

Parameters:

localId - the local ID

clientPidMapRef - the ID used to reference the property's globally unique identifier in the CLIENTPIDMAP property.

See Also:

VCardSubTypes.addPid(int, int)

removePids

public void removePids()

Removes all PID values.

vCard versions: 4.0

See Also:

VCardSubTypes.removePids()

getPref

public Integer getPref()

Gets the preference value.

vCard versions: 4.0

Returns:

the preference value or null if it doesn't exist

See Also:

VCardSubTypes.getPref()

setPref

public void setPref(Integer pref)

Sets the preference value.

vCard versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

VCardSubTypes.setPref(java.lang.Integer)

getAltId

public String getAltId()

Gets the ALTID.

vCard versions: 4.0

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardSubTypes.getAltId()

setAltId

public void setAltId(String altId)

Sets the ALTID.

vCard versions: 4.0

Parameters:

altId - the ALTID or null to remove

See Also:

VCardSubTypes.setAltId(java.lang.String)

doMarshalSubTypes

protected void doMarshalSubTypes(VCardSubTypes copy,
                                 VCardVersion version,
                                 List<String> warnings,
                                 CompatibilityMode compatibilityMode,
                                 VCard vcard)

Description copied from class: VCardType

Gets the sub types that will be sent over the wire.

If this method is NOT overridden, then the type's sub types will be sent over the wire as-is. In other words, whatever is in the VCardType.subTypes field will be sent. Child classes can override this method in order to modify the sub types before they are marshalled.

Overrides:

doMarshalSubTypes in class VCardType

Parameters:

copy - the sub types that will be marshalled into the vCard. This object is a copy of the VCardType.subTypes field, so any modifications done to this object will not effect the state of the field.

version - the version vCard that is being generated

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the marshalling process

compatibilityMode - allows the programmer to customize the marshalling process depending on the expected consumer of the vCard

vcard - the VCard object that is being marshalled

doMarshalText

protected void doMarshalText(StringBuilder sb,
                             VCardVersion version,
                             List<String> warnings,
                             CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Converts this type object to a string for sending over the wire. It is NOT responsible for folding.

Specified by:

doMarshalText in class VCardType

Parameters:

sb - the buffer to add the marshalled value to

version - the version vCard that is being generated

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the marshalling process

compatibilityMode - allows the programmer to customize the marshalling process depending on the expected consumer of the vCard

doUnmarshalText

protected void doUnmarshalText(String value,
                               VCardVersion version,
                               List<String> warnings,
                               CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Unmarshals the type value from off the wire.

Specified by:

doUnmarshalText in class VCardType

Parameters:

value - the unfolded value from off the wire. If the wire value is in the "quoted-printable" encoding, it will be decoded.

version - the version of the vCard that is being read or null if the VERSION type has not been parsed yet (v3.0 and v4.0 require that the VERSION type be at the top of the vCard, but v2.1 has no such requirement)

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process

compatibilityMode - allows you to customize the unmarshalling process depending on where the vCard came from

doMarshalXml

protected void doMarshalXml(XCardElement parent,
                            List<String> warnings,
                            CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Marshals this type for inclusion in an xCard (XML document). All child classes SHOULD override this, but are not required to.

Overrides:

doMarshalXml in class VCardType

Parameters:

parent - the XML element that the type's value will be inserted into. For example, this would be the "<fn>" element for the "FN" type.

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the marshalling process

compatibilityMode - allows the programmer to customize the marshalling process depending on the expected consumer of the vCard

doUnmarshalXml

protected void doUnmarshalXml(XCardElement element,
                              List<String> warnings,
                              CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Unmarshals the type from an xCard (XML document).

Overrides:

doUnmarshalXml in class VCardType

Parameters:

element - the XML element that contains the type data. For example, this would be the "<fn>" element for the "FN" type. This object will NOT include the "<parameters>" child element (it is removed after being unmarshalled into a VCardSubTypes object).

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process

compatibilityMode - allows the programmer to customize the unmarshalling process depending on where the vCard came from

doUnmarshalHtml

protected void doUnmarshalHtml(HCardElement element,
                               List<String> warnings)

Description copied from class: VCardType

Unmarshals the type from an hCard (HTML document).

Overrides:

doUnmarshalHtml in class VCardType

Parameters:

element - the HTML element that contains the type data.

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process