public class

FamilyName

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

Class Overview

Person's family name.

Summary

Constants
String XML_NAME XML element name
String YOMI XML "yomi" attribute name
Fields
private String value Value
private String yomi Pronunciation help
[Expand]
Inherited Fields
From class com.google.gdata.data.AbstractExtension
Public Constructors
FamilyName()
Default mutable constructor.
FamilyName(String value, String yomi)
Immutable constructor.
Public Methods
boolean equals(Object obj)
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.
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()
void setValue(String value)
Sets the value.
void setYomi(String yomi)
Sets the pronunciation help.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
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: "familyName"

private static final String YOMI

XML "yomi" attribute name

Constant Value: "yomi"

Fields

private String value

Value

private String yomi

Pronunciation help

Public Constructors

public FamilyName ()

Default mutable constructor.

public FamilyName (String value, String yomi)

Immutable constructor.

Parameters
value Value.
yomi Pronunciation help.

Public Methods

public boolean equals (Object obj)

Parameters
obj

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

Sets the value.

Parameters
value Value or null to reset

public void setYomi (String yomi)

Sets the pronunciation help.

Parameters
yomi Pronunciation help or null to reset

public String toString ()

Protected Methods

protected void consumeAttributes (AttributeHelper helper)

Consumes attributes from the attribute helper. May also use consumeContent(boolean) to consume the element's text content. Called from getHandler(ExtensionProfile, String, String, Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
helper Attribute helper
Throws
ParseException

protected void putAttributes (AttributeGenerator generator)

Puts attributes into the attribute generator. Called from generate(XmlWriter, ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
generator Attribute generator

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.