public class Timezone extends VCardProperty implements HasAltId
Defines the timezone that the person lives/works in.
Code sample
VCard vcard = new VCard(); Timezone tz = new Timezone(-5, 0, "America/New_York"); vcard.addTimezone(tz); //using a Java "TimeZone" object java.util.TimeZone javaTz = java.util.TimeZone.getTimeZone("America/New_York"); tz = new Timezone(javaTz); vcard.addTimezone(tz);
Property name: TZ
Supported versions: 2.1, 3.0, 4.0
group, parameters
Constructor and Description |
---|
Timezone(java.lang.Integer hourOffset,
java.lang.Integer minuteOffset)
Creates a timezone property.
|
Timezone(java.lang.Integer hourOffset,
java.lang.Integer minuteOffset,
java.lang.String text)
Creates a timezone property.
|
Timezone(java.lang.String text)
Creates a timezone property.
|
Timezone(java.util.TimeZone timezone)
Creates a timezone property.
|
Timezone(UtcOffset offset)
Creates a timezone property.
|
Timezone(UtcOffset offset,
java.lang.String text)
Creates a timezone property.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_validate(java.util.List<Warning> warnings,
VCardVersion version,
VCard vcard)
Checks the property for data consistency problems or deviations from the
spec.
|
void |
addPid(int localId,
int clientPidMapRef)
Adds a PID value.
|
java.lang.String |
getAltId()
Gets the property's ALTID parameter.
|
java.lang.Integer |
getHourOffset()
Gets the hour component of the UTC offset.
|
java.lang.String |
getMediaType()
Gets the MEDIATYPE parameter.
|
java.lang.Integer |
getMinuteOffset()
Gets the minute component of the UTC offset.
|
UtcOffset |
getOffset()
Gets the UTC offset.
|
java.util.List<java.lang.Integer[]> |
getPids()
Gets all PID values.
|
java.lang.Integer |
getPref()
Gets the preference value.
|
java.lang.String |
getText()
Gets the text portion of the timezone.
|
java.lang.String |
getType()
Gets the TYPE parameter.
|
void |
removePids()
Removes all PID values.
|
void |
setAltId(java.lang.String altId)
Sets the property's ALTID parameter.
|
void |
setMediaType(java.lang.String mediaType)
Sets the MEDIATYPE parameter.
|
void |
setOffset(int hourOffset,
int minuteOffset)
Sets the UTC offset.
|
void |
setOffset(UtcOffset offset)
Sets the UTC offset.
|
void |
setPref(java.lang.Integer pref)
Sets the preference value.
|
void |
setText(java.lang.String text)
Sets the text portion of the timezone.
|
void |
setType(java.lang.String type)
Sets the TYPE parameter.
|
java.util.TimeZone |
toTimeZone()
Creates a
TimeZone representation of this class. |
_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public Timezone(java.lang.String text)
text
- a free-form string representing the timezone, preferably a
timezone ID from the Olson
Database (e.g. "America/New_York")public Timezone(java.lang.Integer hourOffset, java.lang.Integer minuteOffset)
hourOffset
- the hour component of the UTC offset (e.g. -5)minuteOffset
- the minute component of the UTC offset (e.g. 0)public Timezone(UtcOffset offset)
offset
- the UTC offsetpublic Timezone(java.lang.Integer hourOffset, java.lang.Integer minuteOffset, java.lang.String text)
hourOffset
- the hour component of the UTC offset (e.g. -5)minuteOffset
- the minute component of the UTC offset (e.g. 0)text
- a free-form string representing the timezone, preferably a
timezone ID from the Olson
Database (e.g. "America/New_York")public Timezone(UtcOffset offset, java.lang.String text)
offset
- the UTC offsettext
- a free-form string representing the timezone, preferably a
timezone ID from the Olson
Database (e.g. "America/New_York")public Timezone(java.util.TimeZone timezone)
timezone
- the timezonepublic java.lang.Integer getHourOffset()
public java.lang.Integer getMinuteOffset()
public UtcOffset getOffset()
public void setOffset(int hourOffset, int minuteOffset)
hourOffset
- the hour offset (e.g. -5)minuteOffset
- the minute offset (e.g. 0)public void setOffset(UtcOffset offset)
offset
- the UTC offsetpublic java.lang.String getText()
public void setText(java.lang.String text)
text
- a free-form string representing the timezone, preferably a
timezone ID from the Olson
Database (e.g. "America/New_York")public java.util.TimeZone toTimeZone()
TimeZone
representation of this class.TimeZone
object or null if this object contains no
offset datapublic java.lang.String getType()
Supported versions: 4.0
public void setType(java.lang.String type)
Supported versions: 4.0
type
- the TYPE value (this should be either "work" or "home") or
null to removepublic java.lang.String getMediaType()
Supported versions: 4.0
public void setMediaType(java.lang.String mediaType)
Supported versions: 4.0
mediaType
- the media type or null to removepublic java.util.List<java.lang.Integer[]> getPids()
VCardProperty
Gets all PID values.
Supported versions: 4.0
VCardParameters.getPids()
public void addPid(int localId, int clientPidMapRef)
VCardProperty
Adds a PID value.
Supported versions: 4.0
localId
- the local IDclientPidMapRef
- the ID used to reference the property's globally
unique identifier in the CLIENTPIDMAP property.VCardParameters.addPid(int, int)
public void removePids()
VCardProperty
Removes all PID values.
Supported versions: 4.0
VCardParameters.removePids()
public java.lang.Integer getPref()
VCardProperty
Gets the preference value. The lower the number, the more preferred this property instance is compared with other properties in the same vCard of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
Supported versions: 4.0
VCardParameters.getPref()
public void setPref(java.lang.Integer pref)
VCardProperty
Sets the preference value. The lower the number, the more preferred this property instance is compared with other properties in the same vCard of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
Supported versions: 4.0
pref
- the preference value or null to removeVCardParameters.setPref(java.lang.Integer)
public java.lang.String getAltId()
HasAltId
Supported versions: 4.0
getAltId
in interface HasAltId
VCardParameters.getAltId()
public void setAltId(java.lang.String altId)
HasAltId
Supported versions: 4.0
setAltId
in interface HasAltId
altId
- the ALTID or null to removeVCardParameters.setAltId(java.lang.String)
protected void _validate(java.util.List<Warning> warnings, VCardVersion version, VCard vcard)
VCardProperty
_validate
in class VCardProperty
warnings
- the list to add the warnings toversion
- the version to check the property againstvcard
- the vCard this property belongs toThis software is published under the BSD license. Copyright © 2003-${build.year}, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.