Do not generate 'isFoo()' methods
[mdsal.git] / 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  * @deprecated This interface is scheduled for removal in the next major release.
21  */
22 @Deprecated(forRemoval = true)
23 public abstract class WriteableModificationNode implements Identifiable<PathArgument> {
24
25     /**
26      * Gets child which is on path towards subshard.
27      *
28      * @return null if requested child is not subshard or enclosing node of any subshard.
29      */
30     public abstract @Nullable WriteableModificationNode getChild(@NonNull PathArgument node);
31
32     public abstract Map<PathArgument, WriteableModificationNode> getChildrenWithSubshards();
33
34     /**
35      * Creates operation used to modify this node and its children.
36      *
37      * @param parentCursor Cursor associated with parent shard
38      * @return WriteableOperation for this node.
39      */
40     public abstract WriteCursorStrategy createOperation(DOMDataTreeWriteCursor parentCursor);
41
42     public abstract void markDeleted();
43
44 }