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
  13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  15
  16 /**
  17  * A transaction that provides mutation capabilities on a data tree.
  18  * <p>
  19  * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
  20  */
  21 public interface DOMDataTreeWriteTransaction extends AsyncWriteTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> {
  22
  23     /**
  24      * Stores a piece of data at the specified path. This acts as an add / replace
  25      * operation, which is to say that whole subtree will be replaced by the specified data.
  26      * <p>
  27      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
  28      * <p>
  29      * If you need to make sure that a parent object exists but you do not want modify
  30      * its pre-existing state by using put, consider using {@link #merge} instead.
  31      *
  32      * @param store
  33      *            the logical data store which should be modified
  34      * @param path
  35      *            the data object path
  36      * @param data
  37      *            the data object to be written to the specified path
  38      * @throws IllegalStateException
  39      *             if the transaction has already been submitted
  40      */
  41     void put(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  42
  43     /**
  44      * Merges a piece of data with the existing data at a specified path. Any pre-existing data
  45      * which is not explicitly overwritten will be preserved. This means that if you store a container,
  46      * its child lists will be merged.
  47      * <p>
  48      * For more information on usage and examples, please see the documentation in {@link AsyncWriteTransaction}.
  49      *<p>
  50      * If you require an explicit replace operation, use {@link #put} instead.
  51      *
  52      * @param store
  53      *            the logical data store which should be modified
  54      * @param path
  55      *            the data object path
  56      * @param data
  57      *            the data object to be merged to the specified path
  58      * @throws IllegalStateException
  59      *             if the transaction has already been submitted
  60      */
  61     void merge(LogicalDatastoreType store, YangInstanceIdentifier path, NormalizedNode<?, ?> data);
  62
  63     /**
  64      * {@inheritDoc}
  65      */
  66     @Override
  67     public void delete(LogicalDatastoreType store, YangInstanceIdentifier path);
  68 }