2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import java.util.List;
12 import javax.annotation.Nonnull;
13 import javax.annotation.Nullable;
14 import javax.annotation.concurrent.Immutable;
15 import org.opendaylight.yangtools.concepts.SemVer;
18 * This interface contains the methods for getting the data from the YANG
21 * <i>Example of YANG module</i> <code><br>
22 * {@link #getName() <b><font color="#FF0000">module</font></b>} module_name{<br>
23 {@link #getYangVersion() <b><font color="#8b4513">yang-version</font></b>} "1";<br><br>
25 {@link #getNamespace() <b><font color="#00FF00">namespace</font></b>} "urn:module:namespace";<br>
26 {@link #getPrefix() <b><font color="#0000FF">prefix</font></b><a name="prefix"></a>} "prefix";<br><br>
28 {@link #getDescription() <b><font color="#b8860b">description</font></b>} "description test";<br>
29 {@link #getReference() <b><font color="#008b8b">reference</font></b>} "reference test";<br><br>
31 {@link #getOrganization() <b><font color="#606060">organization</font></b>} "John Doe, john.doe@email.com";<br>
32 {@link #getContact() <b><font color="#FF9900">contact</font></b>} "http://www.opendaylight.org/";<br><br>
34 {@link #getFeatures() <b><font color="#8b0000">feature</font></b>} feature-test{<br>
35 description "description of some feature";<br>
38 {@link #getNotifications() <b><font color="#b22222">notification</font></b>} notification-test;<br>
39 {@link #getRpcs() <b><font color="#d2691e">rpc</font></b>} rpc-test;<br>
40 <!-- {@link #getDeviations() <b><font color="#b8860b">deviation</font></b>} deviation-test;<br> -->
41 {@link #getIdentities() <b><font color="#bdb76b">identity</font></b>} identity-test;<br>
42 {@link #getExtensionSchemaNodes() <b><font color="#808000">extension</font></b>} extension-test;<br>
45 {@link #getRevision() <b><font color="#339900">revision</font></b>} 2011-08-27 {<br>
47 {@link #getImports() <b><font color="#9400d3">import</font></b>} other_module {<br>
48 prefix "other_module_prefix"<br>
49 revision-date 2011-08-27<br>
52 container cont {<br>
55 {@link #getAugmentations() <b><font color="#dc143c">augment</font></b>} "/cont" { ;<br>
62 public interface Module extends DataNodeContainer, SourceStreamAware, ModuleIdentifier, NotificationNodeContainer {
64 * Default semantic version of Module.
66 SemVer DEFAULT_SEMANTIC_VERSION = SemVer.create(0, 0, 0);
69 * Returns the prefix of the module
71 * @return string with the module prefix which is specified as argument of
72 * YANG {@link Module <b><font color="#0000FF">prefix</font></b>}
78 * Returns the YANG version.
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
86 // FIXME: version 2.0.0: return YangVersion
87 String getYangVersion();
90 * Returns the module description.
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
96 String getDescription();
99 * Returns the module reference.
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
105 String getReference();
108 * Returns the module organization.
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
114 String getOrganization();
117 * Returns the module contact.
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.
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
130 * Returns imports which represents YANG modules which are imported to this
131 * module via <b>import</b> statement.
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.
137 Set<ModuleImport> getImports();
139 Set<Module> getSubmodules();
142 * Returns <code>FeatureDefinition</code> instances which contain data from
143 * <b>feature</b> statements defined in the module.
145 * The feature is used to define a mechanism by which portions of the schema
146 * are marked as conditional.
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.
152 Set<FeatureDefinition> getFeatures();
155 * Returns <code>AugmentationSchema</code> instances which contain data from
156 * <b>augment</b> statements defined in the module.
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
163 Set<AugmentationSchema> getAugmentations();
166 * Returns <code>RpcDefinition</code> instances which contain data from
167 * <b>rpc</b> statements defined in the module.
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
174 Set<RpcDefinition> getRpcs();
177 * Returns <code>Deviation</code> instances which contain data from
178 * <b>deviation</b> statements defined in the module.
180 * @return set of the deviation instances
182 Set<Deviation> getDeviations();
185 * Returns <code>IdentitySchemaNode</code> instances which contain data from
186 * <b>identity</b> statements defined in the module.
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
193 Set<IdentitySchemaNode> getIdentities();
196 * Returns <code>ExtensionDefinition</code> instances which contain data
197 * from <b>extension</b> statements defined in the module.
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
204 List<ExtensionDefinition> getExtensionSchemaNodes();
207 * Returns unknown nodes defined in module.
209 * @return unknown nodes in lexicographical order
212 List<UnknownSchemaNode> getUnknownSchemaNodes();
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)}
222 @Nullable String getSource();