com.google.gdata.data.docs

Class ExportFormat

java.lang.Object

com.google.gdata.data.AbstractExtension

com.google.gdata.data.ExtensionPoint

com.google.gdata.data.docs.ExportFormat

All Implemented Interfaces:

Extension

public class ExportFormat
extends ExtensionPoint

A map of possible export formats.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportFormat.Source Export source document type.

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

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

localName, namespace

Constructor Summary

Constructors

Constructor and Description
ExportFormat() Default mutable constructor.
ExportFormat(ExportFormat.Source source, String target) Immutable constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper.
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.
ExportFormat.Source	getSource() Returns the export source document type.
String	getTarget() Returns the export target mime type.
int	hashCode()
boolean	hasSource() Returns whether it has the export source document type.
boolean	hasTarget() Returns whether it has the export target mime type.
protected void	putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator.
void	setSource(ExportFormat.Source source) Sets the export source document type.
void	setTarget(String target) Sets the export target mime type.
String	toString()
protected void	validate() Checks the attributes to see if there are any problems.

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExportFormat

public ExportFormat()

Default mutable constructor.

ExportFormat

public ExportFormat(ExportFormat.Source source,
            String target)

Immutable constructor.

Parameters:

source - export source document type.

target - export target mime type.

Method Detail

getSource

public ExportFormat.Source getSource()

Returns the export source document type.

Returns:

export source document type

setSource

public void setSource(ExportFormat.Source source)

Sets the export source document type.

Parameters:

source - export source document type or null to reset

hasSource

public boolean hasSource()

Returns whether it has the export source document type.

Returns:

whether it has the export source document type

getTarget

public String getTarget()

Returns the export target mime type.

Returns:

export target mime type

setTarget

public void setTarget(String target)

Sets the export target mime type.

Parameters:

target - export target mime type or null to reset

hasTarget

public boolean hasTarget()

Returns whether it has the export target mime type.

Returns:

whether it has the export target mime type

validate

protected void validate()

Description copied from class: AbstractExtension

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.

Overrides:

validate in class AbstractExtension

getDefaultDescription

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

putAttributes

protected void putAttributes(AttributeGenerator generator)

Description copied from class: AbstractExtension

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

Overrides:

putAttributes in class AbstractExtension

Parameters:

generator - attribute generator

consumeAttributes

protected void consumeAttributes(AttributeHelper helper)
                          throws ParseException

Description copied from class: AbstractExtension

Consumes attributes from the attribute helper. May also use AttributeHelper.consumeContent(boolean) to consume the element's text content. Called from AbstractExtension.getHandler(com.google.gdata.data.ExtensionProfile, java.lang.String, java.lang.String, org.xml.sax.Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Overrides:

consumeAttributes in class AbstractExtension

Parameters:

helper - attribute helper

Throws:

ParseException - any parsing exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object