ezvcard.property

Class StructuredName

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.StructuredName

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class StructuredName
extends VCardProperty
implements HasAltId

Defines the individual components of the person's name.

Code sample

 VCard vcard = new VCard();
 
 StructuredName n = new StructuredName();
 n.setFamily("House");
 n.setGiven("Gregory");
 n.getPrefixes().add("Dr");
 n.getSuffixes().add("MD");
 vcard.setStructuredName(n);
 

Property name: N

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.29, RFC 2426 p.9, vCard 2.1 p.9

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
StructuredName()
StructuredName(StructuredName original) Copy constructor.

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.
StructuredName	copy() Creates a copy of this property object.
boolean	equals(Object obj)
List<String>	getAdditionalNames() Gets the list that stores additional names the person goes by (for example, a middle name).
String	getAltId() Gets the property's ALTID parameter.
String	getFamily() Gets the family name (aka "surname" or "last name").
String	getGiven() Gets the given name (aka "first name").
String	getLanguage() Gets the language that the property value is written in.
List<String>	getPrefixes() Gets the list that stores the person's honorific prefixes.
List<String>	getSortAs() Gets the list that holds string(s) which define how to sort the vCard.
List<String>	getSuffixes() Gets the list that stores the person's honorary suffixes.
int	hashCode()
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setFamily(String family) Sets the family name (aka "surname" or "last name").
void	setGiven(String given) Sets the given name (aka "first name").
void	setLanguage(String language) Sets the language that the property value is written in.
void	setSortAs(String family) Defines a sortable version of the person's name.
void	setSortAs(String family, String given) Defines a sortable version of the person's name.
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

StructuredName

public StructuredName()

StructuredName

public StructuredName(StructuredName original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getFamily

public String getFamily()

Gets the family name (aka "surname" or "last name").

Returns:

the family name or null if not set

setFamily

public void setFamily(String family)

Sets the family name (aka "surname" or "last name").

Parameters:

family - the family name or null to remove

getGiven

public String getGiven()

Gets the given name (aka "first name").

Returns:

the given name or null if not set

setGiven

public void setGiven(String given)

Sets the given name (aka "first name").

Parameters:

given - the given name or null to remove

getAdditionalNames

public List<String> getAdditionalNames()

Gets the list that stores additional names the person goes by (for example, a middle name).

Returns:

the additional names (this list is mutable)

getPrefixes

public List<String> getPrefixes()

Gets the list that stores the person's honorific prefixes.

Returns:

the prefixes (e.g. "Dr.", "Mr.") (this list is mutable)

getSuffixes

public List<String> getSuffixes()

Gets the list that stores the person's honorary suffixes.

Returns:

the suffixes (e.g. "M.D.", "Jr.") (this list is mutable)

getSortAs

public List<String> getSortAs()

Gets the list that holds string(s) which define how to sort the vCard.

2.1 and 3.0 vCards should use the SortString property instead.

Supported versions: 4.0

Returns:

the sort string(s) (this list is mutable). For example, if the family name is "d'Aboville" and the given name is "Christine", the sort strings might be ["Aboville", "Christine"].

setSortAs

public void setSortAs(String family)

Defines a sortable version of the person's name.

2.1 and 3.0 vCards should use the SortString property instead.

Supported versions: 4.0

Parameters:

family - the sortable version of the family name (for example, "Adboville" if the family name is "d'Aboville") or null to remove

setSortAs

public void setSortAs(String family,
                      String given)

Defines a sortable version of the person's name.

2.1 and 3.0 vCards should use the SortString property instead.

Supported versions: 4.0

Parameters:

family - the sortable version of the family name (for example, "Adboville" if the family name is "d'Aboville")

given - the sortable version of the given name

getLanguage

public 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

setLanguage

public void setLanguage(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

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)

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)

_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

copy

public StructuredName 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