org.opendaylight.mdsal.binding.api

Interface WriteTransaction

All Superinterfaces:

AsyncTransaction<InstanceIdentifier<?>,DataObject>, AsyncWriteTransaction<InstanceIdentifier<?>,DataObject>, org.opendaylight.yangtools.concepts.Identifiable<Object>

All Known Subinterfaces:

ReadWriteTransaction

All Known Implementing Classes:

ForwardingReadWriteTransaction, ForwardingWriteTransaction

public interface WriteTransaction
extends AsyncWriteTransaction<InstanceIdentifier<?>,DataObject>

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

Modifier and Type	Field and Description
static boolean	CREATE_MISSING_PARENTS Flag value indicating that missing parents should be created.
static boolean	FAIL_ON_MISSING_PARENTS Flag value indicating that missing parents should cause an error.

Method Summary

Modifier and Type	Method and Description
void	delete(LogicalDatastoreType store, InstanceIdentifier<?> path) Removes a piece of data from specified path.
<T extends DataObject> void	merge(LogicalDatastoreType store, InstanceIdentifier<T> path, T data) Merges a piece of data with the existing data at a specified path.
<T extends DataObject> void	merge(LogicalDatastoreType store, InstanceIdentifier<T> path, T data, boolean createMissingParents) Merges a piece of data with the existing data at a specified path.
<T extends DataObject> void	put(LogicalDatastoreType store, InstanceIdentifier<T> path, T data) Stores a piece of data at the specified path.
<T extends DataObject> void	put(LogicalDatastoreType store, InstanceIdentifier<T> path, T data, boolean createMissingParents) Stores a piece of data at the specified path.

Methods inherited from interface org.opendaylight.mdsal.common.api.AsyncWriteTransaction

cancel, commit

Methods inherited from interface org.opendaylight.mdsal.common.api.AsyncTransaction

getIdentifier

Field Detail

CREATE_MISSING_PARENTS

static final boolean CREATE_MISSING_PARENTS

Flag value indicating that missing parents should be created.

See Also:

Constant Field Values

FAIL_ON_MISSING_PARENTS

static final boolean FAIL_ON_MISSING_PARENTS

Flag value indicating that missing parents should cause an error.

See Also:

Constant Field Values

Method Detail

put

<T extends DataObject> void put(LogicalDatastoreType store,
                                InstanceIdentifier<T> path,
                                T 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.

This method does not automatically create missing parent nodes. It is equivalent to invoking put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean) with createMissingParents set to false.

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.mdsal.common.api.LogicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>, T) 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

put

<T extends DataObject> void put(LogicalDatastoreType store,
                                InstanceIdentifier<T> path,
                                T data,
                                boolean createMissingParents)

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.mdsal.common.api.LogicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>, T) instead.

Note: Using createMissingParents with value true, may introduce garbage in data store, or recreate nodes, which were deleted by previous transaction.

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

createMissingParents - if CREATE_MISSING_PARENTS, any missing parent nodes will be automatically created using a merge operation.

Throws:

IllegalStateException - if the transaction has already been submitted

merge

<T extends DataObject> void merge(LogicalDatastoreType store,
                                  InstanceIdentifier<T> path,
                                  T 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.

This method does not automatically create missing parent nodes. It is equivalent to invoking merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean) with createMissingParents set to false.

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

If you require an explicit replace operation, use put(org.opendaylight.mdsal.common.api.LogicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>, T) 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

merge

<T extends DataObject> void merge(LogicalDatastoreType store,
                                  InstanceIdentifier<T> path,
                                  T data,
                                  boolean createMissingParents)

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.mdsal.common.api.LogicalDatastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>, T) 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

createMissingParents - if CREATE_MISSING_PARENTS, any missing parent nodes will be automatically created using a merge operation.

Throws:

IllegalStateException - if the transaction has already been submitted

delete

void delete(LogicalDatastoreType store,
            InstanceIdentifier<?> 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<InstanceIdentifier<?>,DataObject>

Parameters:

store - Logical data store which should be modified

path - Data object path