2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.mdsal.dom.api;
10 import org.opendaylight.mdsal.common.api.AsyncWriteTransaction;
11 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
13 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
16 * A transaction that provides mutation capabilities on a data tree.
19 * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
21 public interface DOMDataTreeWriteTransaction extends
22 AsyncWriteTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> {
25 * Stores a piece of data at the specified path. This acts as an add / replace
26 * operation, which is to say that whole subtree will be replaced by the specified data.
29 * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
32 * If you need to make sure that a parent object exists but you do not want modify
33 * its pre-existing state by using put, consider using {@link #merge} instead.
36 * the logical data store which should be modified
38 * the data object path
40 * the data object to be written to the specified path
41 * @throws IllegalStateException
42 * if the transaction has already been submitted
44 void put(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data);
47 * Merges a piece of data with the existing data at a specified path. Any pre-existing data
48 * which is not explicitly overwritten will be preserved. This means that if you store a container,
49 * its child lists will be merged.
52 * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
55 * If you require an explicit replace operation, use {@link #put} instead.
58 * the logical data store which should be modified
60 * the data object path
62 * the data object to be merged to the specified path
63 * @throws IllegalStateException
64 * if the transaction has already been submitted
66 void merge(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data);
70 void delete(LogicalDatastoreType store, YangInstanceIdentifier path);