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