public class

Name

extends Element
java.lang.Object
   ↳ com.google.gdata.model.Element
     ↳ com.google.gdata.model.gd.Name

Class Overview

Name of a person in a structured form.

Summary

Fields
public static final ElementKey<Void, Name> KEY The key for this element.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
Name()
Constructs an instance using the default key.
Protected Constructors
Name(ElementKey<?, ? extends Name> key)
Subclass constructor, allows subclasses to supply their own element key.
Name(ElementKey<?, ? extends Name> key, Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance.
Public Methods
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.
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object

Fields

public static final ElementKey<Void, Name> KEY

The key for this element.

Public Constructors

public Name ()

Constructs an instance using the default key.

Protected Constructors

protected Name (ElementKey<?, ? extends Name> key)

Subclass constructor, allows subclasses to supply their own element key.

Parameters
key

protected Name (ElementKey<?, ? extends Name> key, Element source)

Constructs a new instance by doing a shallow copy of data from an existing Element instance. Will use the given ElementKey as the key for the element. This constructor is used when adapting from one element key to another. You cannot call this constructor directly, instead use createElement(ElementKey, Element).

Parameters
key The key to use for this element.
source Source element

Public Methods

public AdditionalName getAdditionalName ()

Returns the additional name.

Returns
  • additional name

public FamilyName getFamilyName ()

Returns the family name.

Returns
  • family name

public FullName getFullName ()

Returns the full name.

Returns
  • full name

public GivenName getGivenName ()

Returns the given name.

Returns
  • given name

public NamePrefix getNamePrefix ()

Returns the name prefix.

Returns
  • name prefix

public NameSuffix getNameSuffix ()

Returns the name suffix.

Returns
  • name suffix

public boolean hasAdditionalName ()

Returns whether it has the additional name.

Returns
  • whether it has the additional name

public boolean hasFamilyName ()

Returns whether it has the family name.

Returns
  • whether it has the family name

public boolean hasFullName ()

Returns whether it has the full name.

Returns
  • whether it has the full name

public boolean hasGivenName ()

Returns whether it has the given name.

Returns
  • whether it has the given name

public boolean hasNamePrefix ()

Returns whether it has the name prefix.

Returns
  • whether it has the name prefix

public boolean hasNameSuffix ()

Returns whether it has the name suffix.

Returns
  • whether it has the name suffix

public Name lock ()

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.

public static void registerMetadata (MetadataRegistry registry)

Registers the metadata for this element.

Parameters
registry

public Name setAdditionalName (AdditionalName additionalName)

Sets the additional name.

Parameters
additionalName Additional name or null to reset
Returns
  • this to enable chaining setters

public Name setFamilyName (FamilyName familyName)

Sets the family name.

Parameters
familyName Family name or null to reset
Returns
  • this to enable chaining setters

public Name setFullName (FullName fullName)

Sets the full name.

Parameters
fullName Full name or null to reset
Returns
  • this to enable chaining setters

public Name setGivenName (GivenName givenName)

Sets the given name.

Parameters
givenName Given name or null to reset
Returns
  • this to enable chaining setters

public Name setNamePrefix (NamePrefix namePrefix)

Sets the name prefix.

Parameters
namePrefix Name prefix or null to reset
Returns
  • this to enable chaining setters

public Name setNameSuffix (NameSuffix nameSuffix)

Sets the name suffix.

Parameters
nameSuffix Name suffix or null to reset
Returns
  • this to enable chaining setters