yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/UnknownSchemaNode.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 org.opendaylight.yangtools.yang.common.QName;
  11
  12 /**
  13  *
  14  * Contains the methods for getting the details about the unknown node.
  15  *
  16  */
  17 public interface UnknownSchemaNode extends SchemaNode {
  18
  19     /**
  20      * Returns QName instance with the name of the unknown node.
  21      *
  22      * @return QName with name the name of the unknown node.
  23      */
  24     QName getNodeType();
  25
  26     /**
  27      * Returns name of the unknown node.
  28      *
  29      * @return string with the name of unknown node.
  30      */
  31     String getNodeParameter();
  32
  33     /**
  34      *
  35      * Describes whether the node was added through <code>uses</code> YANG
  36      * keyword.
  37      *
  38      * @return boolean value which is <code>true</code> if the node is added by
  39      *         <code>uses</code> YANG keyword
  40      */
  41     boolean isAddedByUses();
  42
  43     /**
  44      *
  45      * Describes whether the node was added through <code>augment</code> YANG
  46      * statement.
  47      *
  48      * @return boolean value which is <code>true</code> if the node is added by
  49      *         <code>augment</code> YANG statement
  50      */
  51     boolean isAddedByAugmentation();
  52
  53     /**
  54      * Get extension definition which identifies this node
  55      *
  56      * @return extension definition if exists, null otherwise
  57      */
  58     ExtensionDefinition getExtensionDefinition();
  59
  60 }