Package org.opendaylight.mdsal.dom.spi.store

Class SnapshotBackedWriteTransaction<T>

java.lang.Object

org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTransaction<T>

org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction<T>

Type Parameters:

T - Identifier type

All Implemented Interfaces:

AutoCloseable, DOMStoreTransaction, DOMStoreWriteTransaction, SnapshotBackedTransaction, Identifiable<Object>

Direct Known Subclasses:

SnapshotBackedReadWriteTransaction

@Beta
public class SnapshotBackedWriteTransaction<T>
extends AbstractDOMStoreTransaction<T>
implements DOMStoreWriteTransaction, SnapshotBackedTransaction

Implementation of Write transaction which is backed by DataTreeSnapshot and executed according to SnapshotBackedWriteTransaction.TransactionReadyPrototype.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotBackedWriteTransaction.TransactionReadyPrototype<T>	Prototype implementation of ready().

Method Summary

Modifier and Type	Method	Description
protected MoreObjects.ToStringHelper	addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)	Add class-specific toString attributes.
void	close()
void	delete(YangInstanceIdentifier path)	Deletes data and whole subtree located at provided path.
Optional<DataTreeSnapshot>	getSnapshot()	Returns the DataTreeSnapshot underlying this transaction.
void	merge(YangInstanceIdentifier path, NormalizedNode data)	Store a provided data at specified path.
DOMStoreThreePhaseCommitCohort	ready()	Seals transaction, and returns three-phase commit cohort associated with this transaction and DOM Store to be coordinated by coordinator.
void	write(YangInstanceIdentifier path, NormalizedNode data)	Store a provided data at specified path.

Methods inherited from class org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTransaction

getDebugContext, getIdentifier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.mdsal.dom.spi.store.DOMStoreTransaction

getIdentifier

Method Detail

write

public void write(YangInstanceIdentifier path,
                  NormalizedNode data)

Description copied from interface: DOMStoreWriteTransaction

Store a provided data at specified path. This acts as a add / replace operation, which is to say that whole subtree will be replaced by specified path.

If you need add or merge of current object with specified use DOMStoreWriteTransaction.merge(YangInstanceIdentifier, NormalizedNode)

Specified by:

write in interface DOMStoreWriteTransaction

Parameters:

path - YangInstanceIdentifier object to be written

data - Data object to be written

merge

public void merge(YangInstanceIdentifier path,
                  NormalizedNode data)

Description copied from interface: DOMStoreWriteTransaction

Store a provided data at specified path. This acts as a add / replace operation, which is to say that whole subtree will be replaced by specified path.

If you need add or merge of current object with specified use DOMStoreWriteTransaction.merge(YangInstanceIdentifier, NormalizedNode)

Specified by:

merge in interface DOMStoreWriteTransaction

Parameters:

path - YangInstanceIdentifier object to be merged

data - Data object to be written

delete

public void delete(YangInstanceIdentifier path)

Description copied from interface: DOMStoreWriteTransaction

Deletes data and whole subtree located at provided path.

Specified by:

delete in interface DOMStoreWriteTransaction

Parameters:

path - Path to delete

ready

public DOMStoreThreePhaseCommitCohort ready()

Description copied from interface: DOMStoreWriteTransaction

Seals transaction, and returns three-phase commit cohort associated with this transaction and DOM Store to be coordinated by coordinator.

Specified by:

ready in interface DOMStoreWriteTransaction

Returns:

Three Phase Commit Cohort instance for this transaction.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DOMStoreTransaction

getSnapshot

public Optional<DataTreeSnapshot> getSnapshot()

Description copied from interface: SnapshotBackedTransaction

Returns the DataTreeSnapshot underlying this transaction. If this transaction is no longer open, Optional.empty() is returned.

Specified by:

getSnapshot in interface SnapshotBackedTransaction

Returns:

DataTreeSnapshot attached to this transaction if this transaction is still open.

addToStringAttributes

protected MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)

Description copied from class: AbstractDOMStoreTransaction

Add class-specific toString attributes.

Overrides:

addToStringAttributes in class AbstractDOMStoreTransaction<T>

Parameters:

toStringHelper - ToStringHelper instance

Returns:

ToStringHelper instance which was passed in