org.opendaylight.mdsal.dom.spi.store

Interface DOMStoreWriteTransaction

All Superinterfaces:

AutoCloseable, DOMStoreTransaction, org.opendaylight.yangtools.concepts.Identifiable<Object>

All Known Subinterfaces:

DOMStoreReadWriteTransaction

All Known Implementing Classes:

SnapshotBackedReadWriteTransaction, SnapshotBackedWriteTransaction

public interface DOMStoreWriteTransaction
extends DOMStoreTransaction

Method Summary

Modifier and Type	Method and Description
void	delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Deletes data and whole subtree located at provided path.
void	merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.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(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Store a provided data at specified path.

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

close, getIdentifier

Method Detail

write

void write(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
           org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

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 merge(YangInstanceIdentifier, NormalizedNode)

Parameters:

path - YangInstanceIdentifier object to be written

data - Data object to be written

Throws:

IllegalStateException - if the client code already sealed transaction and invoked ready()

merge

void merge(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
           org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

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 merge(YangInstanceIdentifier, NormalizedNode)

Parameters:

path - YangInstanceIdentifier object to be merged

data - Data object to be written

Throws:

IllegalStateException - if the client code already sealed transaction and invoked ready()

delete

void delete(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Deletes data and whole subtree located at provided path.

Parameters:

path - Path to delete

Throws:

IllegalStateException - if the client code already sealed transaction and invoked ready()

ready

DOMStoreThreePhaseCommitCohort ready()

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

Returns:

Three Phase Commit Cohort instance for this transaction.