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 openconfig version of Module.
  65      */
  66     SemVer DEFAULT_OPENCONFIG_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     // FIXME: version 2.0.0: return YangVersion
  87     String getYangVersion();
  88
  89     /**
  90      * Returns the module description.
  91      *
  92      * @return string with the module description which is specified as argument
  93      *         of YANG {@link Module <b><font
  94      *         color="#b8860b">description</font></b>} keyword
  95      */
  96     String getDescription();
  97
  98     /**
  99      * Returns the module reference.
 100      *
 101      * @return string with the module reference which is specified as argument
 102      *         of YANG {@link Module <b><font
 103      *         color="#008b8b">reference</font></b>} keyword
 104      */
 105     String getReference();
 106
 107     /**
 108      * Returns the module organization.
 109      *
 110      * @return string with the name of the organization specified in the module
 111      *         as the argument of YANG {@link Module <b><font
 112      *         color="#606060">organization</font></b>} keyword
 113      */
 114     String getOrganization();
 115
 116     /**
 117      * Returns the module contact.
 118      *
 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      * The feature is used to define a mechanism by which portions of the schema
 146      * are marked as conditional.
 147      *
 148      * @return feature statements in lexicographical order which are specified
 149      *         in the module as the argument of YANG {@link Module <b><font
 150      *         color="#8b0000">feature</font></b>} keywords.
 151      */
 152     Set<FeatureDefinition> getFeatures();
 153
 154     /**
 155      * Returns <code>AugmentationSchema</code> instances which contain data from
 156      * <b>augment</b> statements defined in the module.
 157      *
 158      * @return set of the augmentation schema instances which are specified in
 159      *         the module as YANG {@link Module <b><font
 160      *         color="#dc143c">augment</font></b>} keyword and are
 161      *         lexicographically ordered
 162      */
 163     Set<AugmentationSchema> getAugmentations();
 164
 165     /**
 166      * Returns <code>RpcDefinition</code> instances which contain data from
 167      * <b>rpc</b> statements defined in the module.
 168      *
 169      * @return set of the rpc definition instances which are specified in the
 170      *         module as YANG {@link Module <b><font
 171      *         color="#d2691e">rpc</font></b>} keywords and are lexicographicaly
 172      *         ordered
 173      */
 174     Set<RpcDefinition> getRpcs();
 175
 176     /**
 177      * Returns <code>Deviation</code> instances which contain data from
 178      * <b>deviation</b> statements defined in the module.
 179      *
 180      * @return set of the deviation instances
 181      */
 182     Set<Deviation> getDeviations();
 183
 184     /**
 185      * Returns <code>IdentitySchemaNode</code> instances which contain data from
 186      * <b>identity</b> statements defined in the module.
 187      *
 188      * @return set of identity schema node instances which are specified in the
 189      *         module as YANG {@link Module <b><font
 190      *         color="#bdb76b">identity</font></b>} keywords and are
 191      *         lexicographically ordered
 192      */
 193     Set<IdentitySchemaNode> getIdentities();
 194
 195     /**
 196      * Returns <code>ExtensionDefinition</code> instances which contain data
 197      * from <b>extension</b> statements defined in the module.
 198      *
 199      * @return set of extension definition instances which are specified in the
 200      *         module as YANG {@link Module <b><font
 201      *         color="#808000">extension</font></b>} keyword and are
 202      *         lexicographically ordered
 203      */
 204     List<ExtensionDefinition> getExtensionSchemaNodes();
 205
 206     /**
 207      * Returns unknown nodes defined in module.
 208      *
 209      * @return unknown nodes in lexicographical order
 210      */
 211     @Nonnull
 212     List<UnknownSchemaNode> getUnknownSchemaNodes();
 213
 214     /**
 215      * Get YANG source.
 216      *
 217      * @return YANG text of this module, or null if the source is not available.
 218      * @deprecated Use {@link org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository#getSchemaSource(org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier, Class)}
 219      *             instead.
 220      */
 221     @Deprecated
 222     @Nullable String getSource();
 223 }