2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import java.util.List;
12 import org.opendaylight.yangtools.yang.common.QName;
15 * SchemaNode represents a node in schema tree.
17 public interface SchemaNode {
20 * Returns QName of the instance of the type <code>SchemaNode</code>.
22 * @return QName with the name of the schema node
27 * Returns the schema path of the instance of the type
28 * <code>SchemaNode</code> <code>SchemaNode</code>.
30 * @return schema path of the schema node
35 * Returns description of the instance of the type <code>SchemaNode</code>
37 * @return string with textual description the node which represents the
38 * argument of the YANG <code>description</code> substatement
40 String getDescription();
43 * Returns reference of the instance of the type <code>SchemaNode</code>
45 * The reference refers to external document that provides additional
46 * information relevant for the instance of this type.
48 * @return string with the reference to some external document which
49 * represents the argument of the YANG <code>reference</code>
52 String getReference();
55 * Returns status of the instance of the type <code>SchemaNode</code>
57 * @return status of this node which represents the argument of the YANG
58 * <code>status</code> substatement
64 * Returns unknown schema nodes which belongs to this instance of the type
65 * <code>SchemaNode</code>.
67 * @return list of unknown schema nodes defined under this schema node.
69 List<UnknownSchemaNode> getUnknownSchemaNodes();