com.google.gdata.data

Class Person

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.Person

All Implemented Interfaces:

Extension, IPerson

Direct Known Subclasses:

CommentAuthor, LastModifiedBy, SidewikiAuthor

public class Person
extends ExtensionPoint
implements IPerson

Person type used for feed and entry authors and contributors. It may also be used by services' custom elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Person.AtomHandler Parses XML in the Atom format.

Nested classes/interfaces inherited from class com.google.gdata.data.ExtensionPoint

ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler

Nested classes/interfaces inherited from class com.google.gdata.data.AbstractExtension

AbstractExtension.AttributesHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	email Email address.
protected String	name Human-readable name.
protected String	nameLang Language of name.
protected String	uri URI associated with the person.

Fields inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Fields inherited from class com.google.gdata.data.AbstractExtension

localName, namespace

Constructor Summary

Constructors

Constructor and Description
Person() Class constructor.
Person(String name) Constructs a new Person instance with the specified name.
Person(String name, String uri, String email) Constructs a new Person instance with the specified name, URI, and email address.

Method Summary

Methods

Modifier and Type	Method and Description
void	generate(ExtensionProfile extProfile, XmlWriter w, XmlNamespace elementNamespace, String elementName, Collection<XmlWriter.Attribute> attributes) Generates XML.
protected void	generate(XmlWriter w, ExtensionProfile p, XmlNamespace namespace, String localName, List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates XML.
void	generateAtom(ExtensionProfile extProfile, XmlWriter w, String elementName) Generates XML in the Atom format.
void	generateRss(XmlWriter w, String elementName) Generates XML in the RSS format.
String	getEmail() Email address.
XmlParser.ElementHandler	getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
String	getName() Human-readable name.
String	getNameLang() Language of name
String	getUri() Uri associated with the person
void	setEmail(String v)
void	setName(String v)
void	setNameLang(String v)
void	setUri(String v)

Methods inherited from class com.google.gdata.data.ExtensionPoint

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getManifest, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, initializeArbitraryXml, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit, visitChild, visitChildren

Methods inherited from class com.google.gdata.data.AbstractExtension

consumeAttributes, disableStrictValidation, enableStrictValidation, eq, generate, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, putAttributes, sameClassAs, setImmutable, throwExceptionForMissingAttribute, throwExceptionIfImmutable, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

Human-readable name.

nameLang

protected String nameLang

Language of name. Derived from the current state of xml:lang.

uri

protected String uri

URI associated with the person.

email

protected String email

Email address.

Constructor Detail

Person

public Person()

Class constructor.

Person

public Person(String name)

Constructs a new Person instance with the specified name.

Person

public Person(String name,
      String uri,
      String email)

Constructs a new Person instance with the specified name, URI, and email address.

Method Detail

getName

public String getName()

Description copied from interface: IPerson

Human-readable name.

Specified by:

getName in interface IPerson

setName

public void setName(String v)

getNameLang

public String getNameLang()

Description copied from interface: IPerson

Language of name

Specified by:

getNameLang in interface IPerson

setNameLang

public void setNameLang(String v)

getUri

public String getUri()

Description copied from interface: IPerson

Uri associated with the person

Specified by:

getUri in interface IPerson

setUri

public void setUri(String v)

getEmail

public String getEmail()

Description copied from interface: IPerson

Email address.

Specified by:

getEmail in interface IPerson

setEmail

public void setEmail(String v)

generate

public void generate(ExtensionProfile extProfile,
            XmlWriter w,
            XmlNamespace elementNamespace,
            String elementName,
            Collection<XmlWriter.Attribute> attributes)
              throws IOException

Generates XML.

Designed to be used by types that reuse the standard Atom person type.

Parameters:

extProfile - extension profile

w - output writer

elementNamespace - namespace for XML element

elementName - name of XML element

attributes - additional attributes

Throws:

IOException

generate

protected void generate(XmlWriter w,
            ExtensionProfile p,
            XmlNamespace namespace,
            String localName,
            List<XmlWriter.Attribute> attrs,
            AttributeGenerator generator)
                 throws IOException

Generates XML.

Designed to be used by ExtensionPoint types that reuse Person.

Overrides:

generate in class ExtensionPoint

Parameters:

w - XML writer

p - extension profile

namespace - XML namespace for this extension

localName - XML local name for this extension

attrs - list of XML attributes

generator - attribute generator

Throws:

IOException - any I/O exception

generateAtom

public void generateAtom(ExtensionProfile extProfile,
                XmlWriter w,
                String elementName)
                  throws IOException

Generates XML in the Atom format.

Parameters:

extProfile - extension profile

w - output writer

elementName - Atom element name

Throws:

IOException

generateRss

public void generateRss(XmlWriter w,
               String elementName)
                 throws IOException

Generates XML in the RSS format.

Parameters:

w - output writer

elementName - RSS element name

Throws:

IOException

getHandler

public XmlParser.ElementHandler getHandler(ExtensionProfile extProfile,
                                  String namespace,
                                  String localName,
                                  Attributes attrs)

Description copied from class: AbstractExtension

The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.

Specified by:

getHandler in interface Extension

Overrides:

getHandler in class ExtensionPoint

Parameters:

extProfile - extension profile

namespace - extension namespace

localName - tag name, without the namespace prefix

attrs - tag attributes

Returns:

an element handler