TableBatchOperation (Microsoft Azure Storage Android Client SDK 2.0.0 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.ArrayList<TableOperation>
    - - com.microsoft.azure.storage.table.TableBatchOperation

All Implemented Interfaces:

Serializable, Cloneable, Iterable<TableOperation>, Collection<TableOperation>, List<TableOperation>, RandomAccess
```
public class TableBatchOperation
extends ArrayList<TableOperation>
```
A class which represents a batch operation. A batch operation is a collection of table operations which are executed by the Storage Service REST API as a single atomic operation, by invoking an Entity Group Transaction.
A batch operation may contain up to 100 individual table operations, with the requirement that each operation entity must have same partition key. A batch with a retrieve operation cannot contain any other operations. Note that the total payload of a batch operation is limited to 4MB.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

TableBatchOperation()

Constructors
Constructor and Description
`TableBatchOperation()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(int index, TableOperation element)` Adds the table operation at the specified index in the batch operation `ArrayList`.
`boolean`	`add(TableOperation element)` Adds the table operation to the batch operation `ArrayList`.
`boolean`	`addAll(Collection<? extends TableOperation> c)` Adds the collection of table operations to the batch operation `ArrayList`.
`boolean`	`addAll(int index, Collection<? extends TableOperation> c)` Adds the collection of table operations to the batch operation `ArrayList` starting at the specified index.
`void`	`clear()` Clears all table operations from the batch operation.
`void`	`delete(TableEntity entity)` Adds a table operation to delete the specified entity to the batch operation.
`void`	`insert(TableEntity entity)` Adds a table operation to insert the specified entity to the batch operation.
`void`	`insert(TableEntity entity, boolean echoContent)` Adds a table operation to insert the specified entity to the batch operation.
`void`	`insertOrMerge(TableEntity entity)` Adds a table operation to insert or merge the specified entity to the batch operation.
`void`	`insertOrReplace(TableEntity entity)` Adds a table operation to insert or replace the specified entity to the batch operation.
`void`	`merge(TableEntity entity)` Adds a table operation to merge the specified entity to the batch operation.
`TableOperation`	`remove(int index)` Removes the table operation at the specified index from the batch operation.
`boolean`	`remove(Object o)` Removes the specified `Object` from the batch operation.
`boolean`	`removeAll(Collection<?> c)` Removes all elements of the specified collection from the batch operation.
`void`	`replace(TableEntity entity)` Adds a table operation to replace the specified entity to the batch operation.
`void`	`retrieve(String partitionKey, String rowKey, Class<? extends TableEntity> clazzType)` Adds a table operation to retrieve an entity of the specified class type with the specified PartitionKey and RowKey to the batch operation.
`void`	`retrieve(String partitionKey, String rowKey, EntityResolver<?> resolver)` Adds a table operation to retrieve an entity of the specified class type with the specified PartitionKey and RowKey to the batch operation.

Methods inherited from class java.util.ArrayList
clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList
equals, hashCode

Methods inherited from class java.util.AbstractCollection
containsAll, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List
containsAll, equals, hashCode

- Constructor Detail
  - TableBatchOperation
```
public TableBatchOperation()
```
- Method Detail
  - add
```
public void add(int index,
       TableOperation element)
```
    Adds the table operation at the specified index in the batch operation ArrayList.
    
    Specified by:
    
    add in interface List<TableOperation>
    
    Overrides:
    
    add in class ArrayList<TableOperation>
    
    Parameters:
    index - An int which represents the index in the batch operation ArrayList to add the table operation at.
    element - The TableOperation to add to the batch operation.
  - add
```
public boolean add(TableOperation element)
```
    Adds the table operation to the batch operation ArrayList.
    
    Specified by:
    
    add in interface Collection<TableOperation>
    
    Specified by:
    
    add in interface List<TableOperation>
    
    Overrides:
    
    add in class ArrayList<TableOperation>
    
    Parameters:
    element - The TableOperation to add to the batch operation.
    
    Returns:
    true if the operation was added successfully.
  - addAll
```
public boolean addAll(int index,
             Collection<? extends TableOperation> c)
```
    Adds the collection of table operations to the batch operation ArrayList starting at the specified index.
    
    Specified by:
    
    addAll in interface List<TableOperation>
    
    Overrides:
    
    addAll in class ArrayList<TableOperation>
    
    Parameters:
    index - An int which represents the index in the batch operation ArrayList to add the table operation at.
    c - A java.util.Collection of TableOperation objects to add to the batch operation.
    
    Returns:
    true if the operations were added successfully.
  - addAll
```
public boolean addAll(Collection<? extends TableOperation> c)
```
    Adds the collection of table operations to the batch operation ArrayList.
    
    Specified by:
    
    addAll in interface Collection<TableOperation>
    
    Specified by:
    
    addAll in interface List<TableOperation>
    
    Overrides:
    
    addAll in class ArrayList<TableOperation>
    
    Parameters:
    c - A java.util.Collection of TableOperation objects to add to the batch operation.
    
    Returns:
    true if the operations were added successfully.
  - clear
```
public void clear()
```
    Clears all table operations from the batch operation.
    
    Specified by:
    
    clear in interface Collection<TableOperation>
    
    Specified by:
    
    clear in interface List<TableOperation>
    
    Overrides:
    
    clear in class ArrayList<TableOperation>
  - delete
```
public void delete(TableEntity entity)
```
    Adds a table operation to delete the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to delete.
  - insert
```
public void insert(TableEntity entity)
```
    Adds a table operation to insert the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to insert.
  - insert
```
public void insert(TableEntity entity,
          boolean echoContent)
```
    Adds a table operation to insert the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to insert.
    echoContent - The boolean representing whether the message payload should be returned in the response.
  - insertOrMerge
```
public void insertOrMerge(TableEntity entity)
```
    Adds a table operation to insert or merge the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to insert if not found or to merge if it exists.
  - insertOrReplace
```
public void insertOrReplace(TableEntity entity)
```
    Adds a table operation to insert or replace the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to insert if not found or to replace if it exists.
  - merge
```
public void merge(TableEntity entity)
```
    Adds a table operation to merge the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to merge.
  - retrieve
```
public void retrieve(String partitionKey,
            String rowKey,
            Class<? extends TableEntity> clazzType)
```
    Adds a table operation to retrieve an entity of the specified class type with the specified PartitionKey and RowKey to the batch operation.
    
    Parameters:
    partitionKey - A String containing the PartitionKey of the entity to retrieve.
    rowKey - A String containing the RowKey of the entity to retrieve.
    clazzType - The class of the TableEntity type for the entity to retrieve.
  - retrieve
```
public void retrieve(String partitionKey,
            String rowKey,
            EntityResolver<?> resolver)
```
    Adds a table operation to retrieve an entity of the specified class type with the specified PartitionKey and RowKey to the batch operation.
    
    Parameters:
    partitionKey - A String containing the PartitionKey of the entity to retrieve.
    rowKey - A String containing the RowKey of the entity to retrieve.
    resolver - The EntityResolver implementation to project the entity to retrieve as a particular type in the result.
  - remove
```
public TableOperation remove(int index)
```
    Removes the table operation at the specified index from the batch operation.
    
    Specified by:
    
    remove in interface List<TableOperation>
    
    Overrides:
    
    remove in class ArrayList<TableOperation>
    
    Parameters:
    index - An int which represents the index in the ArrayList of the table operation to remove from the batch operation.
  - remove
```
public boolean remove(Object o)
```
    Removes the specified Object from the batch operation.
    
    Specified by:
    
    remove in interface Collection<TableOperation>
    
    Specified by:
    
    remove in interface List<TableOperation>
    
    Overrides:
    
    remove in class ArrayList<TableOperation>
    
    Parameters:
    o - The Object to remove from the batch operation.
    
    Returns:
    true if the object was removed successfully.
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Removes all elements of the specified collection from the batch operation.
    
    Specified by:
    
    removeAll in interface Collection<TableOperation>
    
    Specified by:
    
    removeAll in interface List<TableOperation>
    
    Overrides:
    
    removeAll in class ArrayList<TableOperation>
    
    Parameters:
    c - The collection of elements to remove from the batch operation.
    
    Returns:
    true if the objects in the collection were removed successfully.
  - replace
```
public void replace(TableEntity entity)
```
    Adds a table operation to replace the specified entity to the batch operation.
    
    Parameters:
    entity - The TableEntity to replace.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class TableBatchOperation

Constructor Summary

Method Summary

Methods inherited from class java.util.ArrayList

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Constructor Detail

TableBatchOperation

Method Detail

add

add

addAll

addAll

clear

delete

insert

insert

insertOrMerge

insertOrReplace

merge

retrieve

retrieve

remove

remove

removeAll

replace