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

   1 package org.opendaylight.yangtools.yang.model.api;
   2
   3 /**
   4  *
   5  * Node which can have documentation assigned.
   6  *
   7  */
   8 public interface DocumentedNode {
   9
  10     /**
  11      * Returns description of the instance of the type <code>SchemaNode</code>
  12      *
  13      * @return string with textual description the node which represents the
  14      *         argument of the YANG <code>description</code> substatement
  15      */
  16     String getDescription();
  17
  18     /**
  19      * Returns reference of the instance of the type <code>SchemaNode</code>
  20      *
  21      * The reference refers to external document that provides additional
  22      * information relevant for the instance of this type.
  23      *
  24      * @return string with the reference to some external document which
  25      *         represents the argument of the YANG <code>reference</code>
  26      *         substatement
  27      */
  28     String getReference();
  29
  30     /**
  31      * Returns status of the instance of the type <code>SchemaNode</code>
  32      *
  33      * @return status of this node which represents the argument of the YANG
  34      *         <code>status</code> substatement
  35      */
  36     Status getStatus();
  37 }