yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/SchemaNode.java

   1 /*
   2  * Copyright (c) 2013 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.yangtools.yang.model.api;
   9
  10 import java.util.List;
  11
  12 import org.opendaylight.yangtools.yang.common.QName;
  13
  14 /**
  15  * SchemaNode represents a node in schema tree.
  16  */
  17 public interface SchemaNode extends DocumentedNode {
  18
  19     /**
  20      * Returns QName of the instance of the type <code>SchemaNode</code>.
  21      *
  22      * @return QName with the name of the schema node
  23      */
  24     QName getQName();
  25
  26     /**
  27      * Returns the schema path of the instance of the type
  28      * <code>SchemaNode</code> <code>SchemaNode</code>.
  29      *
  30      * @return schema path of the schema node
  31      */
  32     SchemaPath getPath();
  33
  34     /**
  35      *
  36      * Returns unknown schema nodes which belongs to this instance of the type
  37      * <code>SchemaNode</code>.
  38      *
  39      * @return list of unknown schema nodes defined under this schema node.
  40      */
  41     List<UnknownSchemaNode> getUnknownSchemaNodes();
  42
  43 }