Telephone (ez-vcard 0.12.1 API)

java.lang.Object
- ezvcard.property.VCardProperty
- - ezvcard.property.Telephone

All Implemented Interfaces:: HasAltId, Comparable<VCardProperty>

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.getTypes().add(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.getTypes().add(TelephoneType.WORK);
 tel.setPref(1); //the most preferred
 vcard.addTelephoneNumber(tel);

Property name: TEL

Supported versions: 2.1, 3.0, 4.0

Author:: Michael Angstadt
See Also:: RFC 6350 p.34, RFC 2426 p.14, vCard 2.1 p.13

Field Summary
- Fields inherited from class ezvcard.property.VCardProperty
  group, parameters

Constructor Summary

Constructors
Constructor and Description
`Telephone(String text)` Creates a telephone property.
`Telephone(Telephone original)` Copy constructor.
`Telephone(TelUri uri)` Creates a telephone property.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_validate(List<ValidationWarning> warnings, VCardVersion version, VCard vcard)` Checks the property for data consistency problems or deviations from the spec.
`Telephone`	`copy()` Creates a copy of this property object.
`boolean`	`equals(Object obj)`
`String`	`getAltId()` Gets the property's ALTID parameter.
`List<Pid>`	`getPids()` Gets the list that stores this property's PID (property ID) parameter values.
`Integer`	`getPref()` Gets this property's preference value.
`String`	`getText()` Gets the telephone number as a text value.
`List<TelephoneType>`	`getTypes()` Gets the list that stores this property's telephone types (TYPE parameters).
`TelUri`	`getUri()` Gets a "tel" URI representing the phone number.
`int`	`hashCode()`
`void`	`setAltId(String altId)` Sets the property's ALTID parameter.
`void`	`setPref(Integer pref)` Sets this property's 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.
`protected Map<String,Object>`	`toStringValues()` Gets string representations of the class's fields for the `VCardProperty.toString()` method.

Methods inherited from class ezvcard.property.VCardProperty
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Telephone
```
public Telephone(String text)
```
    Creates a telephone property.
    
    Parameters:
    
    text - the telephone number (e.g. "(123) 555-6789")
  - Telephone
```
public Telephone(TelUri uri)
```
    Creates a telephone property.
    
    Parameters:
    
    uri - a "tel" URI representing the telephone number (vCard 4.0 only)
  - Telephone
```
public Telephone(Telephone original)
```
    Copy constructor.
    
    Parameters:
    
    original - the property to make a copy of
- Method Detail
  - getText
```
public String getText()
```
    Gets the telephone number as a text value.
    
    Returns:
    
    the telephone number or null if the text value is not set
  - setText
```
public void setText(String text)
```
    Sets the telephone number as a text value.
    
    Parameters:
    
    text - the telephone number
  - getUri
```
public TelUri getUri()
```
    Gets a "tel" URI representing the phone number.
    Supported versions: 4.0
    
    Returns:
    
    the "tel" URI or null if it is not set
  - setUri
```
public void setUri(TelUri uri)
```
    Sets a "tel" URI representing the phone number.
    Supported versions: 4.0
    
    Parameters:
    
    uri - the "tel" URI
  - getTypes
```
public List<TelephoneType> getTypes()
```
    Gets the list that stores this property's telephone types (TYPE parameters).
    
    Returns:
    
    the telephone types (e.g. "HOME", "WORK") (this list is mutable)
  - getPids
```
public List<Pid> getPids()
```
    Description copied from class: VCardProperty
    
    Gets the list that stores this property's PID (property ID) parameter values.
    
    PIDs can exist on any property where multiple instances are allowed (such as Email or Address, but not StructuredName because only 1 instance of this property is allowed per vCard).
    
    When used in conjunction with the ClientPidMap property, it allows an individual property instance to be uniquely identifiable. This feature is made use of when two different versions of the same vCard have to be merged together (called "synchronizing").
    
    Supported versions: 4.0
    
    Returns:
    
    the PID parameter values (this list is mutable)
    
    See Also:
    
    RFC 6350 p.19
  - getPref
```
public Integer getPref()
```
    Description copied from class: VCardProperty
    Gets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
    
    In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.
```
 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 
```
    Supported versions: 4.0
    Returns:
    
    the preference value or null if not set
    
    See Also:
    
    RFC 6350 p.17
  - setPref
```
public void setPref(Integer pref)
```
    Description copied from class: VCardProperty
    Sets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
    
    In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.
```
 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 
```
    Supported versions: 4.0
    Parameters:
    
    pref - the preference value or null to remove
    
    See Also:
    
    RFC 6350 p.17
  - getAltId
```
public String getAltId()
```
    Description copied from interface: HasAltId
    
    Gets the property's ALTID parameter.
    Supported versions: 4.0
    
    Specified by:
    
    getAltId in interface HasAltId
    
    Returns:
    
    the ALTID or null if it doesn't exist
    
    See Also:
    
    VCardParameters.getAltId()
  - setAltId
```
public void setAltId(String altId)
```
    Description copied from interface: HasAltId
    
    Sets the property's ALTID parameter.
    Supported versions: 4.0
    
    Specified by:
    
    setAltId in interface HasAltId
    
    Parameters:
    
    altId - the ALTID or null to remove
    
    See Also:
    
    VCardParameters.setAltId(java.lang.String)
  - _validate
```
protected void _validate(List<ValidationWarning> warnings,
                         VCardVersion version,
                         VCard vcard)
```
    Description copied from class: VCardProperty
    
    Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.
    
    Overrides:
    
    _validate in class VCardProperty
    
    Parameters:
    
    warnings - the list to add the warnings to
    
    version - the version to check the property against
    
    vcard - the vCard this property belongs to
  - toStringValues
```
protected Map<String,Object> toStringValues()
```
    Description copied from class: VCardProperty
    
    Gets string representations of the class's fields for the VCardProperty.toString() method.
    
    Meant to be overridden by child classes. The default implementation returns an empty map.
    
    Overrides:
    
    toStringValues in class VCardProperty
    
    Returns:
    
    the values of the class's fields (key = field name, value = field value)
  - copy
```
public Telephone copy()
```
    Description copied from class: VCardProperty
    
    Creates a copy of this property object.
    
    The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.
    
    The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.
    
    This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).
    
    Overrides:
    
    copy in class VCardProperty
    
    Returns:
    
    the copy
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VCardProperty
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class VCardProperty

Class Telephone

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

Constructor Summary

Method Summary

Methods inherited from class ezvcard.property.VCardProperty

Methods inherited from class java.lang.Object

Constructor Detail

Telephone

Telephone

Telephone

Method Detail

getText

setText

getUri

setUri

getTypes

getPids

getPref

setPref

getAltId

setAltId

_validate

toStringValues

copy

hashCode

equals