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

   1 /*
   2  * Copyright (c) 2015 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.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  11 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  12 import org.opendaylight.yangtools.yang.data.api.schema.tree.BackendFailedException;
  13
  14 public interface DOMDataTreeWriteCursor extends DOMDataTreeCursor {
  15
  16     /**
  17      * Delete the specified child.
  18      *
  19      * @param child Child identifier
  20      * @throws BackendFailedException when implementation-specific errors occurs while servicing the
  21      *         request.
  22      */
  23     void delete(PathArgument child);
  24
  25     /**
  26      * Merge the specified data with the currently-present data at specified path.
  27      *
  28      * @param child Child identifier
  29      * @param data Data to be merged
  30      * @throws BackendFailedException when implementation-specific errors occurs while servicing the
  31      *         request.
  32      */
  33     void merge(PathArgument child, NormalizedNode<?, ?> data);
  34
  35     /**
  36      * Replace the data at specified path with supplied data.
  37      *
  38      * @param child Child identifier
  39      * @param data New node data
  40      * @throws BackendFailedException when implementation-specific errors occurs while servicing the
  41      *         request.
  42      */
  43     void write(PathArgument child, NormalizedNode<?, ?> data);
  44 }