Google Data APIs Client Library (1.38.0)

com.google.gdata.data.batch
Class BatchOperation

java.lang.Object
  com.google.gdata.data.AbstractExtension
      com.google.gdata.data.ExtensionPoint
          com.google.gdata.data.batch.BatchOperation

All Implemented Interfaces:

Extension

public class BatchOperation
extends ExtensionPoint
implements Extension

Entry and Feed extension that defines the batch operation to apply, defined by its type (BatchOperationType).

Nested Class Summary

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

BatchOperation()
Creates a BatchOperation without type.

BatchOperation(BatchOperationType type)
Creates a new BatchOperation object.

Method Summary

void	generate(com.google.gdata.util.common.xml.XmlWriter w, ExtensionProfile extProfile) Generates an XML representation for the extension.
static ExtensionDescription	getDefaultDescription() Returns the suggested extension description.
XmlParser.ElementHandler	getHandler(ExtensionProfile extProfile, java.lang.String namespace, java.lang.String localName, org.xml.sax.Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension.
BatchOperationType	getType() Gets the operation type (BatchOperationType.DELETE, BatchOperationType.INSERT or BatchOperationType.UPDATE.
void	setType(BatchOperationType type) Sets the operation type.

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

addExtension, addExtension, addRepeatingExtension, addRepeatingExtension, checkRequiredExtensions, createExtensionInstance, declareExtensions, generate, 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, eq, generateAttributes, getExtensionLocalName, getExtensionNamespace, isImmutable, 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

BatchOperation

public BatchOperation(BatchOperationType type)

Creates a new BatchOperation object.

BatchOperation

public BatchOperation()

Creates a BatchOperation without type.

Method Detail

getDefaultDescription

public static ExtensionDescription getDefaultDescription()

Returns the suggested extension description.

getType

public BatchOperationType getType()

Gets the operation type (BatchOperationType.DELETE, BatchOperationType.INSERT or BatchOperationType.UPDATE.

setType

public void setType(BatchOperationType type)

Sets the operation type.

generate

public void generate(com.google.gdata.util.common.xml.XmlWriter w,
                     ExtensionProfile extProfile)
              throws java.io.IOException

Description copied from interface: Extension

Generates an XML representation for the extension.

Specified by:

generate in interface Extension

Overrides:

generate in class AbstractExtension

Parameters:

w - XML writer

extProfile - extension profile

Throws:

java.io.IOException

getHandler

public XmlParser.ElementHandler getHandler(ExtensionProfile extProfile,
                                           java.lang.String namespace,
                                           java.lang.String localName,
                                           org.xml.sax.Attributes attrs)
                                    throws ParseException

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

Throws:

ParseException - when an unexpected tag or badly-formatted XML is detected