dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteOperations.java

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