com.google.gdata.data

Class ExtensionDescription

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.ExtensionDescription

All Implemented Interfaces:

Extension, Comparable<ExtensionDescription>

public class ExtensionDescription
extends ExtensionPoint
implements Comparable<ExtensionDescription>

The ExtensionDescription class describes the attributes of an XML extension type. This description can be declared within an ExtensionProfile to indicate that the extension is expected within a particular ExtensionPoint.

See Also:

ExtensionProfile.declare(Class, ExtensionDescription)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExtensionDescription.Default The Default interface defines a simple annotation model for describing the default ExtensionDescription of an Extension class.
class	ExtensionDescription.Handler Reads the ExtensionDescription XML 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 inherited from class com.google.gdata.data.ExtensionPoint

xmlBlob

Constructor Summary

Constructors

Constructor and Description
ExtensionDescription() Constructs an uninitialized ExtensionDescription.
ExtensionDescription(Class<? extends Extension> extensionClass, XmlNamespace namespace, String localName) Constructs a new ExtensionDescription for an optional, non-repeating simple element.
ExtensionDescription(Class<? extends Extension> extensionClass, XmlNamespace namespace, String localName, boolean required, boolean repeatable, boolean aggregate) Constructs a new ExtensionDescription populated with the parameter values.
ExtensionDescription(Class<? extends Extension> extensionClass, XmlNamespace namespace, String localName, boolean required, boolean repeatable, boolean aggregate, boolean arbitraryXml, boolean mixedContent) Constructs a new ExtensionDescription populated with the parameter values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowsArbitraryXml()
boolean	allowsMixedContent()
int	compareTo(ExtensionDescription desc) Defines a natural ordering for ExtensionDescription based upon the qualified name of the mapped XML element.
void	generateConfig(XmlWriter w, ExtensionProfile extProfile) Generates XML in the external config format.
static ExtensionDescription	getDefaultDescription(Class<? extends Extension> extensionClass) Returns the default ExtensionDescription for the specified Extension class.
Class<? extends Extension>	getExtensionClass()
String	getLocalName()
XmlNamespace	getNamespace()
boolean	isAggregate()
boolean	isRepeatable()
boolean	isRequired()
void	setAggregate(boolean aggregate)
void	setArbitraryXml(boolean arbitraryXml)
void	setExtensionClass(Class<? extends Extension> extensionClass)
void	setLocalName(String localName)
void	setMixedContent(boolean mixedContent)
void	setNamespace(XmlNamespace namespace)
void	setRepeatable(boolean repeatable)
void	setRequired(boolean required)

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

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, generateCumulativeXmlBlob, generateExtensions, generateStartElement, getExtension, getExtensionDescription, getExtensionHandler, getExtensions, getHandler, 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

Constructor Detail

ExtensionDescription

public ExtensionDescription()

Constructs an uninitialized ExtensionDescription.

ExtensionDescription

public ExtensionDescription(Class<? extends Extension> extensionClass,
                    XmlNamespace namespace,
                    String localName,
                    boolean required,
                    boolean repeatable,
                    boolean aggregate)

Constructs a new ExtensionDescription populated with the parameter values.

ExtensionDescription

public ExtensionDescription(Class<? extends Extension> extensionClass,
                    XmlNamespace namespace,
                    String localName,
                    boolean required,
                    boolean repeatable,
                    boolean aggregate,
                    boolean arbitraryXml,
                    boolean mixedContent)

Constructs a new ExtensionDescription populated with the parameter values.

ExtensionDescription

public ExtensionDescription(Class<? extends Extension> extensionClass,
                    XmlNamespace namespace,
                    String localName)

Constructs a new ExtensionDescription for an optional, non-repeating simple element.

Method Detail

getDefaultDescription

public static ExtensionDescription getDefaultDescription(Class<? extends Extension> extensionClass)

Returns the default ExtensionDescription for the specified Extension class.

Parameters:

extensionClass - the target extension class.

Returns:

default description for the target extension class.

Throws:

IllegalArgumentException - if a default description could not be fourn for the extension class.

setNamespace

public void setNamespace(XmlNamespace namespace)

getNamespace

public final XmlNamespace getNamespace()

setLocalName

public void setLocalName(String localName)

getLocalName

public final String getLocalName()

setExtensionClass

public void setExtensionClass(Class<? extends Extension> extensionClass)

getExtensionClass

public final Class<? extends Extension> getExtensionClass()

setRequired

public void setRequired(boolean required)

isRequired

public final boolean isRequired()

setRepeatable

public void setRepeatable(boolean repeatable)

isRepeatable

public final boolean isRepeatable()

setAggregate

public void setAggregate(boolean aggregate)

isAggregate

public final boolean isAggregate()

setArbitraryXml

public void setArbitraryXml(boolean arbitraryXml)

allowsArbitraryXml

public final boolean allowsArbitraryXml()

setMixedContent

public void setMixedContent(boolean mixedContent)

allowsMixedContent

public final boolean allowsMixedContent()

compareTo

public int compareTo(ExtensionDescription desc)

Defines a natural ordering for ExtensionDescription based upon the qualified name of the mapped XML element. Elements with no namespace are considered to precede all others.

Specified by:

compareTo in interface Comparable<ExtensionDescription>

generateConfig

public void generateConfig(XmlWriter w,
                  ExtensionProfile extProfile)
                    throws IOException

Generates XML in the external config format.

Parameters:

w - Output writer.

extProfile - Extension profile.

Throws:

IOException