Merge "Added documentation for web socket client"
[yangtools.git] / yang / yang-data-api / src / main / java / org / opendaylight / yangtools / yang / data / api / Node.java
1 /*\r
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
3  *\r
4  * This program and the accompanying materials are made available under the\r
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
7  */\r
8 package org.opendaylight.yangtools.yang.data.api;\r
9 \r
10 import java.util.Map.Entry;\r
11 \r
12 import org.opendaylight.yangtools.yang.common.QName;\r
13 \r
14 /**\r
15  * Base representation of node in the data tree, defines basic parameters of\r
16  * node such as a QName.\r
17  *\r
18  *\r
19  * @param <T>\r
20  */\r
21 public interface Node<T> extends Entry<QName, T> {\r
22 \r
23     /**\r
24      * Returns the name of the Node\r
25      *\r
26      * @return qName of node\r
27      */\r
28     QName getNodeType();\r
29 \r
30     /**\r
31      * Returns parent node\r
32      *\r
33      * @return parent node\r
34      */\r
35     @Deprecated\r
36     CompositeNode getParent();\r
37 \r
38     /**\r
39      * Returns the value that holds current node, if no value is defined method\r
40      * can return <code>null</code>\r
41      *\r
42      * @return Returns the value that holds current node.\r
43      */\r
44     @Override\r
45     T getValue();\r
46 }\r