org.opendaylight.mdsal.dom.spi.shard

Interface DOMDataTreeShardWriteTransaction

All Superinterfaces:

DOMDataTreeCursorProvider

@Beta
public interface DOMDataTreeShardWriteTransaction
extends DOMDataTreeCursorProvider

Method Summary

Modifier and Type	Method and Description
void	close() Close this transaction and all other foreign shard transactions that were opened as a part of this transaction.
com.google.common.util.concurrent.ListenableFuture<Void>	commit()
@NonNull DOMDataTreeWriteCursor	createCursor(@NonNull DOMDataTreeIdentifier prefix) Create a new write cursor.
com.google.common.util.concurrent.ListenableFuture<Void>	prepare()
void	ready() Finish this transaction and submit it for processing.
com.google.common.util.concurrent.ListenableFuture<Void>	submit()
com.google.common.util.concurrent.ListenableFuture<Boolean>	validate()

Method Detail

createCursor

@NonNull DOMDataTreeWriteCursor createCursor(@NonNull DOMDataTreeIdentifier prefix)

Create a new write cursor. Any previous cursors have to be DOMDataTreeCursor.close()d.

Specified by:

createCursor in interface DOMDataTreeCursorProvider

Parameters:

prefix - Tree identifier of the apex at which the cursor is rooted.

Returns:

A new cursor rooted at specified prefx.

Throws:

IllegalStateException - if a previous cursor has not been closed.

NullPointerException - if prefix is null.

ready

void ready()

Finish this transaction and submit it for processing.

FIXME: this method should accept a callback which will report success/failure. Let's not use a CheckedFuture due to overhead associated with attaching listeners to them.

Throws:

IllegalStateException - if this transaction has an unclosed cursor.

close

void close()

Close this transaction and all other foreign shard transactions that were opened as a part of this transaction.

submit

com.google.common.util.concurrent.ListenableFuture<Void> submit()

validate

com.google.common.util.concurrent.ListenableFuture<Boolean> validate()

prepare

com.google.common.util.concurrent.ListenableFuture<Void> prepare()

commit

com.google.common.util.concurrent.ListenableFuture<Void> commit()