dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/shard/WriteableModificationNode.java

   1 /*
   2  * Copyright (c) 2016 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.spi.shard;
   9
  10 import java.util.Map;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.eclipse.jdt.annotation.Nullable;
  13 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
  14 import org.opendaylight.yangtools.concepts.Identifiable;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  16
  17 /**
  18  * Writable node that can have subshard children somewhere on lower level.
  19  */
  20 public abstract class WriteableModificationNode implements Identifiable<PathArgument> {
  21
  22     /**
  23      * Gets child which is on path towards subshard.
  24      *
  25      * @return null if requested child is not subshard or enclosing node of any subshard.
  26      */
  27     public abstract @Nullable WriteableModificationNode getChild(@NonNull PathArgument node);
  28
  29     public abstract Map<PathArgument, WriteableModificationNode> getChildrenWithSubshards();
  30
  31     /**
  32      * Creates operation used to modify this node and its children.
  33      *
  34      * @param parentCursor Cursor associated with parent shard
  35      * @return WriteableOperation for this node.
  36      */
  37     public abstract WriteCursorStrategy createOperation(DOMDataTreeWriteCursor parentCursor);
  38
  39     public abstract void markDeleted();
  40
  41 }