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