public class

GivenName

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

Class Overview

Person's given name.

Summary

Fields
public static final ElementKey<String, GivenName> KEY The key for this element.
public static final AttributeKey<String> YOMI Pronunciation help.
[Expand]
Inherited Fields
From class com.google.gdata.model.Element
Public Constructors
GivenName()
Constructs an instance using the default key.
GivenName(String value)
Constructs a new instance with the given value.
Protected Constructors
GivenName(ElementKey<String, ? extends GivenName> key)
Subclass constructor, allows subclasses to supply their own element key.
GivenName(ElementKey<String, ? extends GivenName> key, Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance.
Public Methods
boolean equals(Object obj)
String getValue()
Returns the value.
String getYomi()
Returns the pronunciation help.
boolean hasValue()
Returns whether it has the value.
boolean hasYomi()
Returns whether it has the pronunciation help.
int hashCode()
GivenName lock()
Locks this element.
static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
GivenName setValue(String value)
Sets the value.
GivenName setYomi(String yomi)
Sets the pronunciation help.
[Expand]
Inherited Methods
From class com.google.gdata.model.Element
From class java.lang.Object

Fields

public static final ElementKey<String, GivenName> KEY

The key for this element.

public static final AttributeKey<String> YOMI

Pronunciation help.

Public Constructors

public GivenName ()

Constructs an instance using the default key.

public GivenName (String value)

Constructs a new instance with the given value.

Parameters
value Value.

Protected Constructors

protected GivenName (ElementKey<String, ? extends GivenName> key)

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

Parameters
key

protected GivenName (ElementKey<String, ? extends GivenName> 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 boolean equals (Object obj)

Parameters
obj

public String getValue ()

Returns the value.

Returns
  • value

public String getYomi ()

Returns the pronunciation help.

Returns
  • pronunciation help

public boolean hasValue ()

Returns whether it has the value.

Returns
  • whether it has the value

public boolean hasYomi ()

Returns whether it has the pronunciation help.

Returns
  • whether it has the pronunciation help

public int hashCode ()

public GivenName 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 GivenName setValue (String value)

Sets the value.

Parameters
value Value or null to reset
Returns
  • this to enable chaining setters

public GivenName setYomi (String yomi)

Sets the pronunciation help.

Parameters
yomi Pronunciation help or null to reset
Returns
  • this to enable chaining setters