dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeWriteTransaction.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.mdsal.dom.api;
   9
  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;
  14
  15 /**
  16  * A transaction that provides mutation capabilities on a data tree.
  17  *
  18  * <p>
  19  * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
  20  */
  21 public interface DOMDataTreeWriteTransaction extends
  22     AsyncWriteTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> {
  23
  24     /**
  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.
  27      *
  28      * <p>
  29      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
  30      *
  31      * <p>
  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.
  34      *
  35      * @param store
  36      *            the logical data store which should be modified
  37      * @param path
  38      *            the data object path
  39      * @param data
  40      *            the data object to be written to the specified path
  41      * @throws IllegalStateException
  42      *             if the transaction has already been submitted
  43      */
  44     void put(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  45
  46     /**
  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.
  50      *
  51      * <p>
  52      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
  53      *
  54      *<p>
  55      * If you require an explicit replace operation, use {@link #put} instead.
  56      *
  57      * @param store
  58      *            the logical data store which should be modified
  59      * @param path
  60      *            the data object path
  61      * @param data
  62      *            the data object to be merged to the specified path
  63      * @throws IllegalStateException
  64      *             if the transaction has already been submitted
  65      */
  66     void merge(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  67
  68
  69     @Override
  70     void delete(LogicalDatastoreType store, YangInstanceIdentifier path);
  71 }