org.opendaylight.mdsal.binding.dom.adapter

Class BindingDOMCursorAwareWriteTransactionAdapter<T extends DOMDataTreeCursorAwareTransaction>

java.lang.Object

org.opendaylight.mdsal.binding.dom.adapter.BindingDOMCursorAwareWriteTransactionAdapter<T>

All Implemented Interfaces:

CursorAwareWriteTransaction, DataTreeCursorProvider

public class BindingDOMCursorAwareWriteTransactionAdapter<T extends DOMDataTreeCursorAwareTransaction>
extends Object
implements CursorAwareWriteTransaction

Constructor Summary

Constructors

Constructor and Description
BindingDOMCursorAwareWriteTransactionAdapter(T delegate, BindingToNormalizedNodeCodec codec)

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancels the transaction.
<P extends DataObject> DataTreeWriteCursor	createCursor(DataTreeIdentifier<P> path) Create a DataTreeWriteCursor anchored at the specified path.
com.google.common.util.concurrent.CheckedFuture<Void,TransactionCommitFailedException>	submit() Submits this transaction to be asynchronously applied to update the logical data tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BindingDOMCursorAwareWriteTransactionAdapter

public BindingDOMCursorAwareWriteTransactionAdapter(T delegate,
                                                    BindingToNormalizedNodeCodec codec)

Method Detail

createCursor

@Nullable
public <P extends DataObject> DataTreeWriteCursor createCursor(DataTreeIdentifier<P> path)

Description copied from interface: CursorAwareWriteTransaction

Create a DataTreeWriteCursor anchored at the specified path. There can only be one cursor open at a time.

Specified by:

createCursor in interface CursorAwareWriteTransaction

Specified by:

createCursor in interface DataTreeCursorProvider

Parameters:

path - Path at which the cursor is to be anchored

Returns:

write cursor at the desired location.

cancel

public boolean cancel()

Description copied from interface: CursorAwareWriteTransaction

Cancels the transaction.

Transactions can only be cancelled if it was not yet submited.

Invoking cancel() on failed or already canceled will have no effect, and transaction is considered cancelled.

Invoking cancel() on finished transaction (future returned by CursorAwareWriteTransaction.submit() already successfully completed) will always fail (return false).

Specified by:

cancel in interface CursorAwareWriteTransaction

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

submit

public com.google.common.util.concurrent.CheckedFuture<Void,TransactionCommitFailedException> submit()

Description copied from interface: CursorAwareWriteTransaction

Submits this transaction to be asynchronously applied to update the logical data tree. The returned CheckedFuture conveys the result of applying the data changes.

Note: It is strongly recommended to process the CheckedFuture result in an asynchronous manner rather than using the blocking get() method.

This call logically seals the transaction, which prevents the client from further changing data tree using this transaction's cursor. Any subsequent calls to createCursorCursor(DOMDataTreeIdentifier or any of the cursor's methods will fail with IllegalStateException.

The transaction is marked as submitted and enqueued into the shard back-end for processing.

Specified by:

submit in interface CursorAwareWriteTransaction