yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/Module.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 import java.util.Set;
  12 import javax.annotation.Nonnull;
  13 import javax.annotation.concurrent.Immutable;
  14 import org.opendaylight.yangtools.concepts.SemVer;
  15
  16 /**
  17  * This interface contains the methods for getting the data from the YANG
  18  * module.<br>
  19  * <br>
  20  * <i>Example of YANG module</i> <code><br>
  21  * {@link #getName() <b><font color="#FF0000">module</font></b>} module_name{<br>
  22     &nbsp;&nbsp;{@link #getYangVersion() <b><font color="#8b4513">yang-version</font></b>} "1";<br><br>
  23
  24     &nbsp;&nbsp;{@link #getNamespace() <b><font color="#00FF00">namespace</font></b>} "urn:module:namespace";<br>
  25     &nbsp;&nbsp;{@link #getPrefix() <b><font color="#0000FF">prefix</font></b><a name="prefix"></a>} "prefix";<br><br>
  26
  27     &nbsp;&nbsp;{@link #getDescription() <b><font color="#b8860b">description</font></b>} "description test";<br>
  28     &nbsp;&nbsp;{@link #getReference() <b><font color="#008b8b">reference</font></b>} "reference test";<br><br>
  29
  30     &nbsp;&nbsp;{@link #getOrganization() <b><font color="#606060">organization</font></b>}
  31     "John Doe, john.doe@email.com";<br>
  32     &nbsp;&nbsp;{@link #getContact() <b><font color="#FF9900">contact</font></b>} "http://www.opendaylight.org/";<br>
  33     <br>
  34
  35     &nbsp;&nbsp;{@link #getFeatures() <b><font color="#8b0000">feature</font></b>} feature-test{<br>
  36     &nbsp;&nbsp;&nbsp;&nbsp; description "description of some feature";<br>
  37     &nbsp;&nbsp;}<br>
  38
  39     &nbsp;&nbsp;{@link #getNotifications() <b><font color="#b22222">notification</font></b>} notification-test;<br>
  40     &nbsp;&nbsp;{@link #getRpcs() <b><font color="#d2691e">rpc</font></b>} rpc-test;<br>
  41     <!-- &nbsp;&nbsp;{@link #getDeviations() <b><font color="#b8860b">deviation</font></b>} deviation-test;<br> -->
  42     &nbsp;&nbsp;{@link #getIdentities() <b><font color="#bdb76b">identity</font></b>} identity-test;<br>
  43     &nbsp;&nbsp;{@link #getExtensionSchemaNodes() <b><font color="#808000">extension</font></b>} extension-test;<br>
  44
  45
  46     &nbsp;&nbsp;{@link #getRevision() <b><font color="#339900">revision</font></b>} 2011-08-27 {<br>
  47
  48     &nbsp;&nbsp;{@link #getImports() <b><font color="#9400d3">import</font></b>} other_module {<br>
  49     &nbsp;&nbsp;&nbsp;&nbsp;prefix "other_module_prefix"<br>
  50     &nbsp;&nbsp;&nbsp;&nbsp;revision-date 2011-08-27<br>
  51     &nbsp;&nbsp;}<br><br>
  52
  53     &nbsp;&nbsp;container cont {<br>
  54     &nbsp;&nbsp;}<br>
  55
  56     &nbsp;&nbsp;{@link #getAugmentations() <b><font color="#dc143c">augment</font></b>} "/cont" { ;<br>
  57     &nbsp;&nbsp;}<br>
  58     }
  59
  60     </code>
  61  */
  62 @Immutable
  63 public interface Module extends DataNodeContainer, ModuleIdentifier, NotificationNodeContainer {
  64     /**
  65      * Default semantic version of Module.
  66      */
  67     SemVer DEFAULT_SEMANTIC_VERSION = SemVer.create(0, 0, 0);
  68
  69     /**
  70      * Returns the prefix of the module.
  71      *
  72      * @return string with the module prefix which is specified as argument of
  73      *         YANG {@link Module <b><font color="#0000FF">prefix</font></b>}
  74      *         keyword
  75      */
  76     String getPrefix();
  77
  78     /**
  79      * Returns the YANG version. Default value is 1.
  80      *
  81      * @return string with the module YANG version which is specified as
  82      *         argument of YANG {@link Module <b> <font
  83      *         color="#8b4513">yang-version</font></b>} keyword
  84      */
  85     // FIXME: version 2.0.0: return YangVersion
  86     String getYangVersion();
  87
  88     /**
  89      * Returns the module description.
  90      *
  91      * @return string with the module description which is specified as argument
  92      *         of YANG {@link Module <b><font
  93      *         color="#b8860b">description</font></b>} keyword
  94      */
  95     String getDescription();
  96
  97     /**
  98      * Returns the module reference.
  99      *
 100      * @return string with the module reference which is specified as argument
 101      *         of YANG {@link Module <b><font
 102      *         color="#008b8b">reference</font></b>} keyword
 103      */
 104     String getReference();
 105
 106     /**
 107      * Returns the module organization.
 108      *
 109      * @return string with the name of the organization specified in the module
 110      *         as the argument of YANG {@link Module <b><font
 111      *         color="#606060">organization</font></b>} keyword
 112      */
 113     String getOrganization();
 114
 115     /**
 116      * Returns the module contact.
 117      *
 118      * <p>
 119      * The contact represents the person or persons to whom technical queries
 120      * concerning this module should be sent, such as their name, postal
 121      * address, telephone number, and electronic mail address.
 122      *
 123      * @return string with the contact data specified in the module as the
 124      *         argument of YANG {@link Module <b><font
 125      *         color="#FF9900">contact</font></b>} keyword
 126      */
 127     String getContact();
 128
 129     /**
 130      * Returns imports which represents YANG modules which are imported to this
 131      * module via <b>import</b> statement.
 132      *
 133      * @return set of module imports which are specified in the module as the
 134      *         argument of YANG {@link Module <b><font
 135      *         color="#9400d3">import</font></b>} keywords.
 136      */
 137     Set<ModuleImport> getImports();
 138
 139     Set<Module> getSubmodules();
 140
 141     /**
 142      * Returns <code>FeatureDefinition</code> instances which contain data from
 143      * <b>feature</b> statements defined in the module.
 144      *
 145      * <p>
 146      * The feature is used to define a mechanism by which portions of the schema
 147      * are marked as conditional.
 148      *
 149      * @return feature statements in lexicographical order which are specified
 150      *         in the module as the argument of YANG {@link Module <b><font
 151      *         color="#8b0000">feature</font></b>} keywords.
 152      */
 153     Set<FeatureDefinition> getFeatures();
 154
 155     /**
 156      * Returns <code>AugmentationSchema</code> instances which contain data from
 157      * <b>augment</b> statements defined in the module.
 158      *
 159      * @return set of the augmentation schema instances which are specified in
 160      *         the module as YANG {@link Module <b><font
 161      *         color="#dc143c">augment</font></b>} keyword and are
 162      *         lexicographically ordered
 163      */
 164     Set<AugmentationSchema> getAugmentations();
 165
 166     /**
 167      * Returns <code>RpcDefinition</code> instances which contain data from
 168      * <b>rpc</b> statements defined in the module.
 169      *
 170      * @return set of the rpc definition instances which are specified in the
 171      *         module as YANG {@link Module <b><font
 172      *         color="#d2691e">rpc</font></b>} keywords and are lexicographicaly
 173      *         ordered
 174      */
 175     Set<RpcDefinition> getRpcs();
 176
 177     /**
 178      * Returns <code>Deviation</code> instances which contain data from
 179      * <b>deviation</b> statements defined in the module.
 180      *
 181      * @return set of the deviation instances
 182      */
 183     Set<Deviation> getDeviations();
 184
 185     /**
 186      * Returns <code>IdentitySchemaNode</code> instances which contain data from
 187      * <b>identity</b> statements defined in the module.
 188      *
 189      * @return set of identity schema node instances which are specified in the
 190      *         module as YANG {@link Module <b><font
 191      *         color="#bdb76b">identity</font></b>} keywords and are
 192      *         lexicographically ordered
 193      */
 194     Set<IdentitySchemaNode> getIdentities();
 195
 196     /**
 197      * Returns <code>ExtensionDefinition</code> instances which contain data
 198      * from <b>extension</b> statements defined in the module.
 199      *
 200      * @return set of extension definition instances which are specified in the
 201      *         module as YANG {@link Module <b><font
 202      *         color="#808000">extension</font></b>} keyword and are
 203      *         lexicographically ordered
 204      */
 205     List<ExtensionDefinition> getExtensionSchemaNodes();
 206
 207     /**
 208      * Returns unknown nodes defined in module.
 209      *
 210      * @return unknown nodes in lexicographical order
 211      */
 212     @Nonnull
 213     List<UnknownSchemaNode> getUnknownSchemaNodes();
 214 }