com.google.gdata.model.gd
Class Name

java.lang.Object
  extended by com.google.gdata.model.Element
      extended by com.google.gdata.model.gd.Name

public class Name
extends Element

Name of a person in a structured form.


Field Summary
static ElementKey<java.lang.Void,Name> KEY
          The key for this element.
 
Constructor Summary
Name()
          Constructs an instance using the default key.
 
Method Summary
 AdditionalName getAdditionalName()
          Returns the additional name.
 FamilyName getFamilyName()
          Returns the family name.
 FullName getFullName()
          Returns the full name.
 GivenName getGivenName()
          Returns the given name.
 NamePrefix getNamePrefix()
          Returns the name prefix.
 NameSuffix getNameSuffix()
          Returns the name suffix.
 boolean hasAdditionalName()
          Returns whether it has the additional name.
 boolean hasFamilyName()
          Returns whether it has the family name.
 boolean hasFullName()
          Returns whether it has the full name.
 boolean hasGivenName()
          Returns whether it has the given name.
 boolean hasNamePrefix()
          Returns whether it has the name prefix.
 boolean hasNameSuffix()
          Returns whether it has the name suffix.
 Name lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 Name setAdditionalName(AdditionalName additionalName)
          Sets the additional name.
 Name setFamilyName(FamilyName familyName)
          Sets the family name.
 Name setFullName(FullName fullName)
          Sets the full name.
 Name setGivenName(GivenName givenName)
          Sets the given name.
 Name setNamePrefix(NamePrefix namePrefix)
          Sets the name prefix.
 Name setNameSuffix(NameSuffix nameSuffix)
          Sets the name suffix.
 
Methods inherited from class com.google.gdata.model.Element
addElement, addElement, addElement, clear, createElement, createElement, equals, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hashCode, hasTextValue, isLocked, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, visit
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY

public static final ElementKey<java.lang.Void,Name> KEY
The key for this element.

Constructor Detail

Name

public Name()
Constructs an instance using the default key.

Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.


lock

public Name lock()
Description copied from class: Element
Locks this element. A locked element cannot have any changes made to its content or its attributes or child elements. This will also lock all attributes and child elements as well. Once this method has been called, this element can be safely published to other threads.

Overrides:
lock in class Element

getAdditionalName

public AdditionalName getAdditionalName()
Returns the additional name.

Returns:
additional name

setAdditionalName

public Name setAdditionalName(AdditionalName additionalName)
Sets the additional name.

Parameters:
additionalName - additional name or null to reset
Returns:
this to enable chaining setters

hasAdditionalName

public boolean hasAdditionalName()
Returns whether it has the additional name.

Returns:
whether it has the additional name

getFamilyName

public FamilyName getFamilyName()
Returns the family name.

Returns:
family name

setFamilyName

public Name setFamilyName(FamilyName familyName)
Sets the family name.

Parameters:
familyName - family name or null to reset
Returns:
this to enable chaining setters

hasFamilyName

public boolean hasFamilyName()
Returns whether it has the family name.

Returns:
whether it has the family name

getFullName

public FullName getFullName()
Returns the full name.

Returns:
full name

setFullName

public Name setFullName(FullName fullName)
Sets the full name.

Parameters:
fullName - full name or null to reset
Returns:
this to enable chaining setters

hasFullName

public boolean hasFullName()
Returns whether it has the full name.

Returns:
whether it has the full name

getGivenName

public GivenName getGivenName()
Returns the given name.

Returns:
given name

setGivenName

public Name setGivenName(GivenName givenName)
Sets the given name.

Parameters:
givenName - given name or null to reset
Returns:
this to enable chaining setters

hasGivenName

public boolean hasGivenName()
Returns whether it has the given name.

Returns:
whether it has the given name

getNamePrefix

public NamePrefix getNamePrefix()
Returns the name prefix.

Returns:
name prefix

setNamePrefix

public Name setNamePrefix(NamePrefix namePrefix)
Sets the name prefix.

Parameters:
namePrefix - name prefix or null to reset
Returns:
this to enable chaining setters

hasNamePrefix

public boolean hasNamePrefix()
Returns whether it has the name prefix.

Returns:
whether it has the name prefix

getNameSuffix

public NameSuffix getNameSuffix()
Returns the name suffix.

Returns:
name suffix

setNameSuffix

public Name setNameSuffix(NameSuffix nameSuffix)
Sets the name suffix.

Parameters:
nameSuffix - name suffix or null to reset
Returns:
this to enable chaining setters

hasNameSuffix

public boolean hasNameSuffix()
Returns whether it has the name suffix.

Returns:
whether it has the name suffix