public class

Name

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.extensions.Name

Class Overview

Name of a person in a structured form.

Summary

Constants
String XML_NAME XML element name
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
Name()
Default mutable constructor.
Public Methods
void declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
AdditionalName getAdditionalName()
Returns the additional name.
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.
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.
void setAdditionalName(AdditionalName additionalName)
Sets the additional name.
void setFamilyName(FamilyName familyName)
Sets the family name.
void setFullName(FullName fullName)
Sets the full name.
void setGivenName(GivenName givenName)
Sets the given name.
void setNamePrefix(NamePrefix namePrefix)
Sets the name prefix.
void setNameSuffix(NameSuffix nameSuffix)
Sets the name suffix.
String toString()
Protected Methods
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

static final String XML_NAME

XML element name

Constant Value: "name"

Public Constructors

public Name ()

Default mutable constructor.

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Parameters
extProfile The ExtensionProfile to initialize.

public AdditionalName getAdditionalName ()

Returns the additional name.

Returns
  • additional name

public static ExtensionDescription getDefaultDescription (boolean required, boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters
required Whether it is required
repeatable Whether it is repeatable
Returns
  • extension description

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 void setAdditionalName (AdditionalName additionalName)

Sets the additional name.

Parameters
additionalName Additional name or null to reset

public void setFamilyName (FamilyName familyName)

Sets the family name.

Parameters
familyName Family name or null to reset

public void setFullName (FullName fullName)

Sets the full name.

Parameters
fullName Full name or null to reset

public void setGivenName (GivenName givenName)

Sets the given name.

Parameters
givenName Given name or null to reset

public void setNamePrefix (NamePrefix namePrefix)

Sets the name prefix.

Parameters
namePrefix Name prefix or null to reset

public void setNameSuffix (NameSuffix nameSuffix)

Sets the name suffix.

Parameters
nameSuffix Name suffix or null to reset

public String toString ()

Protected Methods

protected void validate ()

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.