org.opendaylight.controller.md.sal.dom.api

Interface DOMDataWriteTransaction

All Superinterfaces:

AsyncTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, AsyncWriteTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>, org.opendaylight.yangtools.concepts.Identifiable<Object>

All Known Subinterfaces:

DOMDataReadWriteTransaction

All Known Implementing Classes:

ForwardingDOMDataReadWriteTransaction, ForwardingDOMDataWriteTransaction

public interface DOMDataWriteTransaction
extends AsyncWriteTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

A transaction that provides mutation capabilities on a data tree.

For more information on usage and examples, please see the documentation in AsyncWriteTransaction.

Field Summary

Fields inherited from interface org.opendaylight.controller.md.sal.common.api.data.AsyncWriteTransaction

SUBMIT_EXCEPTION_MAPPER

Method Summary

Modifier and Type	Method and Description
void	delete(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Removes a piece of data from specified path.
void	merge(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Merges a piece of data with the existing data at a specified path.
void	put(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Stores a piece of data at the specified path.

Methods inherited from interface org.opendaylight.controller.md.sal.common.api.data.AsyncWriteTransaction

cancel, commit, submit

Methods inherited from interface org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction

getIdentifier

Method Detail

delete

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

Description copied from interface: AsyncWriteTransaction

Removes a piece of data from specified path. This operation does not fail if the specified path does not exist.

Specified by:

delete in interface AsyncWriteTransaction<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>

Parameters:

store - Logical data store which should be modified

path - Data object path

put

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

Stores a piece of data at the specified path. This acts as an add / replace operation, which is to say that whole subtree will be replaced by the specified data.

For more information on usage and examples, please see the documentation in AsyncWriteTransaction.

If you need to make sure that a parent object exists but you do not want modify its pre-existing state by using put, consider using merge(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?, ?>) instead.

Parameters:

store - the logical data store which should be modified

path - the data object path

data - the data object to be written to the specified path

Throws:

IllegalStateException - if the transaction has already been submitted

merge

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

Merges a piece of data with the existing data at a specified path. Any pre-existing data which is not explicitly overwritten will be preserved. This means that if you store a container, its child lists will be merged.

For more information on usage and examples, please see the documentation in AsyncWriteTransaction.

If you require an explicit replace operation, use put(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?, ?>) instead.

Parameters:

store - the logical data store which should be modified

path - the data object path

data - the data object to be merged to the specified path

Throws:

IllegalStateException - if the transaction has already been submitted