com.google.gdata.model.gd
Class GivenName

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

public class GivenName
extends Element

Person's given name.


Field Summary
static ElementKey<java.lang.String,GivenName> KEY
          The key for this element.
static AttributeKey<java.lang.String> YOMI
          Pronunciation help.
 
Constructor Summary
GivenName()
          Constructs an instance using the default key.
GivenName(java.lang.String value)
          Constructs a new instance with the given value.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getValue()
          Returns the value.
 java.lang.String getYomi()
          Returns the pronunciation help.
 int hashCode()
           
 boolean hasValue()
          Returns whether it has the value.
 boolean hasYomi()
          Returns whether it has the pronunciation help.
 GivenName lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 GivenName setValue(java.lang.String value)
          Sets the value.
 GivenName setYomi(java.lang.String yomi)
          Sets the pronunciation help.
 
Methods inherited from class com.google.gdata.model.Element
addElement, addElement, addElement, clear, createElement, createElement, 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, 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.String,GivenName> KEY
The key for this element.


YOMI

public static final AttributeKey<java.lang.String> YOMI
Pronunciation help.

Constructor Detail

GivenName

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


GivenName

public GivenName(java.lang.String value)
Constructs a new instance with the given value.

Parameters:
value - value.
Method Detail

registerMetadata

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


lock

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

getValue

public java.lang.String getValue()
Returns the value.

Returns:
value

setValue

public GivenName setValue(java.lang.String value)
Sets the value.

Parameters:
value - value or null to reset
Returns:
this to enable chaining setters

hasValue

public boolean hasValue()
Returns whether it has the value.

Returns:
whether it has the value

getYomi

public java.lang.String getYomi()
Returns the pronunciation help.

Returns:
pronunciation help

setYomi

public GivenName setYomi(java.lang.String yomi)
Sets the pronunciation help.

Parameters:
yomi - pronunciation help or null to reset
Returns:
this to enable chaining setters

hasYomi

public boolean hasYomi()
Returns whether it has the pronunciation help.

Returns:
whether it has the pronunciation help

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class Element

hashCode

public int hashCode()
Overrides:
hashCode in class Element