org.opencrx.application.uses.ezvcard.property

Class Nickname

java.lang.Object

org.opencrx.application.uses.ezvcard.property.VCardProperty

org.opencrx.application.uses.ezvcard.property.ListProperty<java.lang.String>

org.opencrx.application.uses.ezvcard.property.TextListProperty

org.opencrx.application.uses.ezvcard.property.Nickname

All Implemented Interfaces:

java.lang.Comparable<VCardProperty>, HasAltId

public class Nickname
extends TextListProperty
implements HasAltId

Defines the person's nicknames.

Code sample

 VCard vcard = new VCard();
 
 Nickname nickname = new Nickname();
 nickname.addValue("Ricky");
 nickname.addValue("Bobby");
 nickname.addValue("Ricky Bobby");
 vcard.setNickname(nickname);
 

Property name: NICKNAME

Supported versions: 3.0, 4.0

Author:

Michael Angstadt

Field Summary

Fields inherited from class org.opencrx.application.uses.ezvcard.property.ListProperty

values

Fields inherited from class org.opencrx.application.uses.ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Nickname()

Method Summary

Modifier and Type	Method and Description
java.util.Set<VCardVersion>	_supportedVersions() Gets the vCard versions that support this property.
void	addPid(int localId, int clientPidMapRef) Adds a PID value.
java.lang.String	getAltId() Gets the property's ALTID parameter.
java.lang.String	getLanguage() Gets the language that the property value is written in.
java.util.List<java.lang.Integer[]>	getPids() Gets all PID values.
java.lang.Integer	getPref() Gets the preference value.
java.lang.String	getType() Gets the TYPE parameter.
void	removePids() Removes all PID values.
void	setAltId(java.lang.String altId) Sets the property's ALTID parameter.
void	setLanguage(java.lang.String language) Sets the language that the property value is written in.
void	setPref(java.lang.Integer pref) Sets the preference value.
void	setType(java.lang.String type) Sets the TYPE parameter.

Methods inherited from class org.opencrx.application.uses.ezvcard.property.ListProperty

_validate, addValue, getValues, removeValue

Methods inherited from class org.opencrx.application.uses.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

Nickname

public Nickname()

Method Detail

_supportedVersions

public java.util.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.

getType

public java.lang.String getType()

Gets the TYPE parameter.

Supported versions: 4.0

Returns:

the TYPE value (typically, this will be either "work" or "home") or null if it doesn't exist

setType

public void setType(java.lang.String type)

Sets the TYPE parameter.

Supported versions: 4.0

Parameters:

type - the TYPE value (this should be either "work" or "home") or null to remove

getLanguage

public java.lang.String getLanguage()

Description copied from class: VCardProperty

Gets the language that the property value is written in.

Returns:

the language or null if not set

See Also:

VCardParameters.getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

Description copied from class: VCardProperty

Sets the language that the property value is written in.

Parameters:

language - the language or null to remove

See Also:

VCardParameters.setLanguage(java.lang.String)

getPids

public java.util.List<java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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)