ezvcard.types
Class NicknameType

java.lang.Object
  ezvcard.types.VCardType
      ezvcard.types.TextListType
          ezvcard.types.NicknameType

All Implemented Interfaces:

Comparable<VCardType>

public class NicknameType
extends TextListType

A list of nicknames the person goes by.

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

vCard property name: NICKNAME

vCard versions: 3.0, 4.0

Author:

Michael Angstadt

Field Summary

static String

NAME

Fields inherited from class ezvcard.types.TextListType

values

Fields inherited from class ezvcard.types.VCardType

group, subTypes, typeName

Constructor Summary

NicknameType()

Method Summary

void	addPid(int localId, int clientPidMapRef) Adds a PID value.
protected void	doUnmarshalHtml(HCardElement element, List<String> warnings) Unmarshals the type from an hCard (HTML document).
String	getAltId() Gets the ALTID.
String	getLanguage() Gets the language the name is written in.
List<Integer[]>	getPids() Gets all PID parameter values.
Integer	getPref() Gets the preference value.
VCardVersion[]	getSupportedVersions() Gets the vCard versions that support this type.
String	getType() Gets the TYPE parameter.
void	removePids() Removes all PID values.
void	setAltId(String altId) Sets the ALTID.
void	setLanguage(String language) Sets the language the name is written in.
void	setPref(Integer pref) Sets the preference value.
void	setType(String type) Sets the TYPE parameter.

Methods inherited from class ezvcard.types.TextListType

addValue, doMarshalText, doMarshalXml, doUnmarshalText, doUnmarshalXml, getValues, removeValue

Methods inherited from class ezvcard.types.VCardType

compareTo, doMarshalSubTypes, getGroup, getQName, getSubTypes, getTypeName, marshalSubTypes, marshalText, marshalXml, setGroup, unmarshalHtml, unmarshalText, unmarshalXml

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

NicknameType

public NicknameType()

Method Detail

getType

public String getType()

Gets the TYPE parameter.

vCard 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(String type)

Sets the TYPE parameter.

vCard versions: 4.0

Parameters:

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

getLanguage

public String getLanguage()

Gets the language the name is written in.

Returns:

the language or null if not set

See Also:

VCardSubTypes.getLanguage()

setLanguage

public void setLanguage(String language)

Sets the language the name is written in.

Parameters:

language - the language or null to remove

See Also:

VCardSubTypes.setLanguage(java.lang.String)

getPids

public List<Integer[]> getPids()

Gets all PID parameter values.

vCard versions: 4.0

Returns:

the PID values or empty set if there are none

See Also:

VCardSubTypes.getPids()

addPid

public void addPid(int localId,
                   int clientPidMapRef)

Adds a PID value.

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

VCardSubTypes.addPid(int, int)

removePids

public void removePids()

Removes all PID values.

vCard versions: 4.0

See Also:

VCardSubTypes.removePids()

getPref

public Integer getPref()

Gets the preference value.

vCard versions: 4.0

Returns:

the preference value or null if it doesn't exist

See Also:

VCardSubTypes.getPref()

setPref

public void setPref(Integer pref)

Sets the preference value.

vCard versions: 4.0

Parameters:

pref - the preference value or null to remove

See Also:

VCardSubTypes.setPref(java.lang.Integer)

getAltId

public String getAltId()

Gets the ALTID.

vCard versions: 4.0

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardSubTypes.getAltId()

setAltId

public void setAltId(String altId)

Sets the ALTID.

vCard versions: 4.0

Parameters:

altId - the ALTID or null to remove

See Also:

VCardSubTypes.setAltId(java.lang.String)

getSupportedVersions

public VCardVersion[] getSupportedVersions()

Description copied from class: VCardType

Gets the vCard versions that support this type.

Overrides:

getSupportedVersions in class VCardType

Returns:

the vCard versions that support this type.

doUnmarshalHtml

protected void doUnmarshalHtml(HCardElement element,
                               List<String> warnings)

Description copied from class: VCardType

Unmarshals the type from an hCard (HTML document).

Overrides:

doUnmarshalHtml in class VCardType

Parameters:

element - the HTML element that contains the type data.

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process