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

   1 /*
   2  * Copyright (c) 2014 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 javax.annotation.Nullable;
  11
  12 /**
  13  *
  14  * Node which can have documentation assigned.
  15  *
  16  */
  17 public interface DocumentedNode {
  18
  19     /**
  20      * Returns description of the instance of the type <code>SchemaNode</code>
  21      *
  22      * @return string with textual description the node which represents the
  23      *         argument of the YANG <code>description</code> substatement
  24      */
  25     String getDescription();
  26
  27     /**
  28      * Returns reference of the instance of the type <code>SchemaNode</code>
  29      *
  30      * The reference refers to external document that provides additional
  31      * information relevant for the instance of this type.
  32      *
  33      * @return string with the reference to some external document which
  34      *         represents the argument of the YANG <code>reference</code>
  35      *         substatement
  36      */
  37     String getReference();
  38
  39     /**
  40      * Returns status of the instance of the type <code>SchemaNode</code>
  41      *
  42      * @return status of this node which represents the argument of the YANG
  43      *         <code>status</code> substatement
  44      */
  45     @Nullable
  46     Status getStatus();
  47 }