/* * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.controller.md.sal.binding.api; import org.opendaylight.controller.md.sal.common.api.data.AsyncWriteTransaction; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.yangtools.yang.binding.DataObject; import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; /** * A transaction that provides mutation capabilities on a data tree. *
* For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
*/
public interface WriteTransaction extends AsyncWriteTransaction
* This method does not automatically create missing parent nodes. It is equivalent to invoking
* {@link #put(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
* with
* For more information on usage and examples, please see the documentation in {@link 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 {@link #merge} instead.
*
* @param store
* the logical data store which should be modified
* @param path
* the data object path
* @param data
* the data object to be written to the specified path
* @throws IllegalStateException
* if the transaction has already been submitted
*/
* For more information on usage and examples, please see the documentation
* in {@link 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 {@link #merge}
* instead.
*
* Note: Using
* This method does not automatically create missing parent nodes. It is equivalent to invoking
* {@link #merge(LogicalDatastoreType, InstanceIdentifier, DataObject, boolean)}
* with
* For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
*
* If you require an explicit replace operation, use {@link #put} instead.
* @param store
* the logical data store which should be modified
* @param path
* the data object path
* @param data
* the data object to be merged to the specified path
* @throws IllegalStateException
* if the transaction has already been submitted
*/
* For more information on usage and examples, please see the documentation
* in {@link AsyncWriteTransaction}.
*
* If you require an explicit replace operation, use {@link #put} instead.
*
* @param store
* the logical data store which should be modified
* @param path
* the data object path
* @param data
* the data object to be merged to the specified path
* @param createMissingParents
* if true, any missing parent nodes will be automatically created
* using a merge operation.
* @throws IllegalStateException
* if the transaction has already been submitted
*/
createMissingParents
set to false.
* createMissingParents
with value true, may
* introduce garbage in data store, or recreate nodes, which were deleted by
* previous transaction.
*
* @param store
* the logical data store which should be modified
* @param path
* the data object path
* @param data
* the data object to be written to the specified path
* @param createMissingParents
* if true, any missing parent nodes will be automatically
* created using a merge operation.
* @throws IllegalStateException
* if the transaction has already been submitted
*/
createMissingParents
set to false.
*