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