com.google.gdata.data.batch

Enum BatchOperationType

java.lang.Object

java.lang.Enum<BatchOperationType>

com.google.gdata.data.batch.BatchOperationType

All Implemented Interfaces:

Serializable, Comparable<BatchOperationType>

public enum BatchOperationType
extends Enum<BatchOperationType>

Defines a batch operation (query, update, insert, delete). This enum is the java equivalent of <batch: operation type="..."/>.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE Delete the current entry identified by its id.
INSERT Insert the current entry.
QUERY Query for the entry by id.
UPDATE Update the current entry identified by its id.

Method Summary

Methods

Modifier and Type	Method and Description
static BatchOperationType	forName(String name) Gets a BatchOperation by name (lowercase), as it appears in XML.
void	generateAtom(XmlWriter w) Generates a batch:operation element.
String	getMethod() Gets the operation name as an HTTP method name.
String	getName() Gets the operation name as it appears in XML.
String	toString()
static BatchOperationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BatchOperationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

QUERY

public static final BatchOperationType QUERY

Query for the entry by id.

INSERT

public static final BatchOperationType INSERT

Insert the current entry.

UPDATE

public static final BatchOperationType UPDATE

Update the current entry identified by its id.

DELETE

public static final BatchOperationType DELETE

Delete the current entry identified by its id.

Method Detail

values

public static BatchOperationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BatchOperationType c : BatchOperationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BatchOperationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Gets the operation name as it appears in XML.

Returns:

operation name

getMethod

public String getMethod()

Gets the operation name as an HTTP method name.

Returns:

HTTP method name

toString

public String toString()

Overrides:

toString in class Enum<BatchOperationType>

forName

public static BatchOperationType forName(String name)

Gets a BatchOperation by name (lowercase), as it appears in XML.

Parameters:

name -

Returns:

a BatchOperation or null

generateAtom

public void generateAtom(XmlWriter w)
                  throws IOException

Generates a batch:operation element.

Parameters:

w -

Throws:

IOException