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