public class Telephone extends VCardProperty implements HasAltId
Defines a telephone number.
Code sample
VCard vcard = new VCard(); //text Telephone tel = new Telephone("(123) 555-6789"); tel.addType(TelephoneType.HOME); tel.setPref(2); //the second-most preferred vcard.addTelephoneNumber(tel); //URI (vCard version 4.0 only) TelUri uri = new TelUri.Builder("+1-800-555-9876").extension("111").build(); tel = new Telephone(uri); tel.addType(TelephoneType.WORK); tel.setPref(1); //the most preferred vcard.addTelephoneNumber(tel);
Property name: TEL
Supported versions: 2.1, 3.0, 4.0
group, parameters
Constructor and Description |
---|
Telephone(String text)
Creates a telephone property.
|
Telephone(TelUri uri)
Creates a telephone property.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_validate(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.
|
void |
addType(TelephoneType type)
Adds a TYPE parameter.
|
String |
getAltId()
Gets the property's ALTID parameter.
|
List<Integer[]> |
getPids()
Gets all PID values.
|
Integer |
getPref()
Gets the preference value.
|
String |
getText()
Gets the telephone number as a text value.
|
Set<TelephoneType> |
getTypes()
Gets all the TYPE parameters.
|
TelUri |
getUri()
Gets a "tel" URI representing the phone number.
|
void |
removePids()
Removes all PID values.
|
void |
removeType(TelephoneType type)
Removes a TYPE parameter.
|
void |
setAltId(String altId)
Sets the property's ALTID parameter.
|
void |
setPref(Integer pref)
Sets the preference value.
|
void |
setText(String text)
Sets the telephone number as a text value.
|
void |
setUri(TelUri uri)
Sets a "tel" URI representing the phone number.
|
_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public Telephone(String text)
text
- the telephone number (e.g. "(123) 555-6789")public Telephone(TelUri uri)
uri
- a "tel" URI representing the telephone number (vCard 4.0 only)public String getText()
public void setText(String text)
text
- the telephone numberpublic TelUri getUri()
Supported versions: 4.0
public void setUri(TelUri uri)
Supported versions: 4.0
uri
- the "tel" URIpublic Set<TelephoneType> getTypes()
public void addType(TelephoneType type)
type
- the TYPE parameter to addpublic void removeType(TelephoneType type)
type
- the TYPE parameter to removepublic List<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 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(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 String getAltId()
HasAltId
Supported versions: 4.0
getAltId
in interface HasAltId
VCardParameters.getAltId()
public void setAltId(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(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.