6a8977154c792084bf53e020ffd94586ccb6017d
[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / md / sal / dom / api / DOMDataWriteTransaction.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.md.sal.dom.api;
9
10 import org.opendaylight.controller.md.sal.common.api.data.AsyncWriteTransaction;
11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
12 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
13 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
14
15 /**
16  * A transaction that provides mutation capabilities on a data tree.
17  * <p>
18  * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
19  */
20 public interface DOMDataWriteTransaction extends AsyncWriteTransaction<InstanceIdentifier, NormalizedNode<?, ?>> {
21
22     /**
23      * Stores a piece of data at the specified path. This acts as an add / replace
24      * operation, which is to say that whole subtree will be replaced by the specified data.
25      * <p>
26      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
27      * <p>
28      * If you need to make sure that a parent object exists but you do not want modify
29      * its pre-existing state by using put, consider using {@link #merge} instead.
30      *
31      * @param store
32      *            the logical data store which should be modified
33      * @param path
34      *            the data object path
35      * @param data
36      *            the data object to be written to the specified path
37      * @throws IllegalStateException
38      *             if the transaction has already been submitted
39      */
40     void put(LogicalDatastoreType store, InstanceIdentifier path, NormalizedNode<?, ?> data);
41
42     /**
43      * Merges a piece of data with the existing data at a specified path. Any pre-existing data
44      * which is not explicitly overwritten will be preserved. This means that if you store a container,
45      * its child lists will be merged.
46      * <p>
47      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
48      *<p>
49      * If you require an explicit replace operation, use {@link #put} instead.
50      *
51      * @param store
52      *            the logical data store which should be modified
53      * @param path
54      *            the data object path
55      * @param data
56      *            the data object to be merged to the specified path
57      * @throws IllegalStateException
58      *             if the transaction has already been submitted
59      */
60     void merge(LogicalDatastoreType store, InstanceIdentifier path, NormalizedNode<?, ?> data);
61 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.