public class Related extends VCardProperty implements HasAltId
Defines someone that the person is related to.
Code sample
VCard vcard = new VCard(); //static factory methods Related related = Related.email("bob.smith@example.com"); related.addType(RelatedType.CO_WORKER); related.addType(RelatedType.FRIEND); vcard.addRelated(related); //free-form text related = new Related(); related.setText("Edna Smith"); related.addType(RelatedType.SPOUSE); vcard.addRelated(related); //reference another vCard by putting its UID property here related = new Related("urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af"); related.addType(RelatedType.SIBLING); vcard.addRelated(related);
Property name: RELATED
Supported versions: 4.0
group, parameters
Constructor and Description |
---|
Related()
Creates a related property
|
Related(String uri)
Creates a related property.
|
Modifier and Type | Method and Description |
---|---|
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.
|
static Related |
email(String email)
Creates a related property whose value is an email address.
|
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.
|
static Related |
im(String protocol,
String handle)
Creates a related property whose value is an instant messenger handle.
|
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.
|
static Related |
telephone(TelUri telUri)
Creates a related property whose value is a telephone number.
|
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate
public Related()
public Related(String uri)
uri
- the URI representing the personpublic static Related email(String email)
email
- the email addresspublic static Related im(String protocol, String handle)
protocol
- the instant messenger protocol (e.g. "aim")handle
- the instant messenger handle (e.g. "johndoe")public static Related telephone(TelUri telUri)
telUri
- the telephone numberpublic Set<VCardVersion> _supportedVersions()
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.
_supportedVersions
in class VCardProperty
public String getUri()
public void setUri(String uri)
uri
- the URIpublic String getText()
public void setText(String text)
text
- the textpublic Set<RelatedType> getTypes()
public void addType(RelatedType type)
type
- the TYPE parameter to addpublic void removeType(RelatedType 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.