ezvcard.property
Class Source

java.lang.Object
  ezvcard.property.VCardProperty
      ezvcard.property.SimpleProperty<String>
          ezvcard.property.TextProperty
              ezvcard.property.UriProperty
                  ezvcard.property.Source

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Source
extends UriProperty
implements HasAltId

A URL that can be used to retrieve the most up-to-date version of the person's vCard.

Code sample

 VCard vcard = new VCard();
 Source source = new Source("http://www.company.com/employees/doe_john.vcf");
 vcard.addSource(source);
 

Property name: SOURCE

Supported versions: 3.0, 4.0

Author:

Michael Angstadt

Field Summary

Fields inherited from class ezvcard.property.SimpleProperty

value

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Source(String url)
Creates a source property.

Method Summary

void	addPid(int localId, int clientPidMapRef) Adds a PID value.
String	getAltId() Gets the property's ALTID parameter.
List<Integer[]>	getPids() Gets all PID values.
Integer	getPref() Gets the preference value.
void	removePids() Removes all PID values.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setPref(Integer pref) Sets the preference value.

Methods inherited from class ezvcard.property.SimpleProperty

_validate, getValue, setValue

Methods inherited from class ezvcard.property.VCardProperty

_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Source

public Source(String url)

Creates a source property.

Parameters:

url - the URL

Method Detail

getPids

public List<Integer[]> getPids()

Description copied from class: VCardProperty

Gets all PID values.

Supported versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardParameters.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Description copied from class: VCardProperty

Adds a PID value.

Supported 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:

VCardParameters.addPid(int, int)

removePids

public void removePids()

Description copied from class: VCardProperty

Removes all PID values.

Supported versions: 4.0

See Also:

VCardParameters.removePids()

getPref

public Integer getPref()

Description copied from class: 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

Returns:

the preference value or null if it doesn't exist

See Also:

VCardParameters.getPref()

setPref

public void setPref(Integer pref)

Description copied from class: 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

Parameters:

pref - the preference value or null to remove

See Also:

VCardParameters.setPref(java.lang.Integer)

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)