ezvcard.property
Class Related

java.lang.Object
  ezvcard.property.VCardProperty
      ezvcard.property.Related

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Related
extends VCardProperty
implements HasAltId

Someone that the person is related to. It can contain either a URI or a plain text value.

Code sample

 VCard vcard = new VCard();
 
 Related related = new Related();
 related.addType(RelatedType.FRIEND);
 related.setUri("urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af");
 vcard.addRelated(related);
 
 related = new Related();
 related.addType(RelatedType.CO_WORKER);
 related.addType(RelatedType.FRIEND);
 related.setUri("http://joesmoe.name/vcard.vcf");
 vcard.addRelated(related);
 
 related = new Related();
 related.addType(RelatedType.SPOUSE);
 related.setText("Edna Smith");
 vcard.addRelated(related);
 

Property name: RELATED

Supported versions: 4.0

Author:

Michael Angstadt

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Related()

Method Summary

Set<VCardVersion>	_supportedVersions() Gets the vCard versions that support this property.
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(RelatedType 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 text value.
Set<RelatedType>	getTypes() Gets all the TYPE parameters.
String	getUri() Gets the URI value.
void	removePids() Removes all PID values.
void	removeType(RelatedType 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 value to free-form text instead of a URI.
void	setUri(String uri) Sets the URI.
void	setUriEmail(String email) Sets the URI to an email address.
void	setUriIM(String protocol, String handle) Sets the URI to an instant messaging handle.
void	setUriTelephone(String telephone) Sets the URI to a telephone number.

Methods inherited from class ezvcard.property.VCardProperty

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

Related

public Related()

Method Detail

_supportedVersions

public Set<VCardVersion> _supportedVersions()

Description copied from class: VCardProperty

Gets the vCard versions that support this property.

This method should be overridden by child classes if the property does not support all vCard versions. The default implementation of this method returns all vCard versions.

Overrides:

_supportedVersions in class VCardProperty

Returns:

the vCard versions that support this property.

getUri

public String getUri()

Gets the URI value.

Returns:

the URI value or null if no URI value is set

setUriEmail

public void setUriEmail(String email)

Sets the URI to an email address.

Parameters:

email - the email address

setUriIM

public void setUriIM(String protocol,
                     String handle)

Sets the URI to an instant messaging handle.

Parameters:

protocol - the IM protocol (e.g. "aim")

handle - the handle

setUriTelephone

public void setUriTelephone(String telephone)

Sets the URI to a telephone number.

Parameters:

telephone - the telephone number

setUri

public void setUri(String uri)

Sets the URI.

Parameters:

uri - the URI

getText

public String getText()

Gets the text value.

Returns:

the text value or null if no text value is set

setText

public void setText(String text)

Sets the value to free-form text instead of a URI.

Parameters:

text - the text

getTypes

public Set<RelatedType> getTypes()

Gets all the TYPE parameters.

Returns:

the TYPE parameters or empty set if there are none

addType

public void addType(RelatedType type)

Adds a TYPE parameter.

Parameters:

type - the TYPE parameter to add

removeType

public void removeType(RelatedType type)

Removes a TYPE parameter.

Parameters:

type - the TYPE parameter to remove

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)

_validate

protected void _validate(List<Warning> 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