ezvcard.property

Class Related

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.Related

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

@SupportedVersions(value=V4_0)
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.getTypes().add(RelatedType.CO_WORKER);
 related.getTypes().add(RelatedType.FRIEND);
 vcard.addRelated(related);
 
 //free-form text
 related = new Related();
 related.setText("Edna Smith");
 related.getTypes().add(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.getTypes().add(RelatedType.SIBLING);
 vcard.addRelated(related);
 

Property name: RELATED

Supported versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.42

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Related() Creates a related property
Related(Related original) Copy constructor.
Related(String uri) Creates a related property.

Method Summary

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.
Related	copy() Creates a copy of this property object.
static Related	email(String email) Creates a related property whose value is an email address.
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 text value.
List<RelatedType>	getTypes() Gets the list that stores this property's relationship types (TYPE parameters).
String	getUri() Gets the URI value.
int	hashCode()
static Related	im(String protocol, String handle) Creates a related property whose value is an instant messenger handle.
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 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.
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

Related

public Related()

Creates a related property

Related

public Related(String uri)

Creates a related property.

Parameters:

uri - the URI representing the person

Related

public Related(Related original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

email

public static Related email(String email)

Creates a related property whose value is an email address.

Parameters:

email - the email address

Returns:

the property

im

public static Related im(String protocol,
                         String handle)

Creates a related property whose value is an instant messenger handle.

Parameters:

protocol - the instant messenger protocol (e.g. "aim")

handle - the instant messenger handle (e.g. "johndoe")

Returns:

the property

telephone

public static Related telephone(TelUri telUri)

Creates a related property whose value is a telephone number.

Parameters:

telUri - the telephone number

Returns:

the property

getUri

public String getUri()

Gets the URI value.

Returns:

the URI value or null if no URI value is set

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 List<RelatedType> getTypes()

Gets the list that stores this property's relationship types (TYPE parameters).

Returns:

the relationship types (e.g. "child", "co-worker") (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 Related 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