2 * Copyright (c) 2018 Pantheon Technologies. 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.LogicalDatastoreType;
11 import org.opendaylight.mdsal.common.api.TransactionDatastoreMismatchException;
12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
13 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
15 public interface DOMDataTreeWriteOperations {
17 * Stores a piece of data at the specified path. This acts as an add / replace operation, which is to say that whole
18 * subtree will be replaced by the specified data.
21 * If you need to make sure that a parent object exists but you do not want modify its pre-existing state by using
22 * put, consider using {@link #merge} instead.
24 * @param store the logical data store which should be modified
25 * @param path the data object path
26 * @param data the data object to be written to the specified path
27 * @throws IllegalArgumentException if {@code store} is not supported
28 * @throws IllegalStateException if the transaction has already been submitted
29 * @throws NullPointerException if any argument is {@code null}
30 * @throws TransactionDatastoreMismatchException if this transaction is already bound to a different data store
32 void put(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode data);
35 * Merges a piece of data with the existing data at a specified path. Any pre-existing data which is not explicitly
36 * overwritten will be preserved. This means that if you store a container, its child lists will be merged.
39 * If you require an explicit replace operation, use {@link #put} instead.
41 * @param store the logical data store which should be modified
42 * @param path the data object path
43 * @param data the data object to be merged to the specified path
44 * @throws IllegalArgumentException if {@code store} is not supported
45 * @throws IllegalStateException if the transaction has already been submitted
46 * @throws NullPointerException if any argument is {@code null}
47 * @throws TransactionDatastoreMismatchException if this transaction is already bound to a different data store
49 void merge(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode data);
52 * Removes a piece of data from specified path. This operation does not fail if the specified path does not exist.
54 * @param store Logical data store which should be modified
55 * @param path Data object path
56 * @throws IllegalArgumentException if {@code store} is not supported
57 * @throws IllegalStateException if the transaction was committed or canceled.
58 * @throws NullPointerException if any argument is {@code null}
59 * @throws TransactionDatastoreMismatchException if this transaction is already bound to a different data store
61 void delete(LogicalDatastoreType store, YangInstanceIdentifier path);