@Immutable public interface Module extends DataNodeContainer, SourceStreamAware, ModuleIdentifier, NotificationNodeContainer
module
module_name{
yang-version
"1";
namespace
"urn:module:namespace";
prefix
"prefix";
description
"description test";
reference
"reference test";
organization
"John Doe, john.doe@email.com";
contact
"http://www.opendaylight.org/";
feature
feature-test{
description "description of some feature";
}
notification
notification-test;
rpc
rpc-test;
identity
identity-test;
extension
extension-test;
revision
2011-08-27 {
import
other_module {
prefix "other_module_prefix"
revision-date 2011-08-27
}
container cont {
}
augment
"/cont" { ;
}
}
Modifier and Type | Field and Description |
---|---|
static SemVer |
DEFAULT_SEMANTIC_VERSION
Default semantic version of Module.
|
Modifier and Type | Method and Description |
---|---|
Set<AugmentationSchema> |
getAugmentations()
Returns
AugmentationSchema instances which contain data from
augment statements defined in the module. |
String |
getContact()
Returns the module contact.
|
String |
getDescription()
Returns the module description.
|
Set<Deviation> |
getDeviations()
Returns
Deviation instances which contain data from
deviation statements defined in the module. |
List<ExtensionDefinition> |
getExtensionSchemaNodes()
Returns
ExtensionDefinition instances which contain data
from extension statements defined in the module. |
Set<FeatureDefinition> |
getFeatures()
Returns
FeatureDefinition instances which contain data from
feature statements defined in the module. |
Set<IdentitySchemaNode> |
getIdentities()
Returns
IdentitySchemaNode instances which contain data from
identity statements defined in the module. |
Set<ModuleImport> |
getImports()
Returns imports which represents YANG modules which are imported to this
module via import statement.
|
String |
getOrganization()
Returns the module organization.
|
String |
getPrefix()
Returns the prefix of the module
|
String |
getReference()
Returns the module reference.
|
Set<RpcDefinition> |
getRpcs()
Returns
RpcDefinition instances which contain data from
rpc statements defined in the module. |
String |
getSource()
|
Set<Module> |
getSubmodules() |
List<UnknownSchemaNode> |
getUnknownSchemaNodes()
Returns unknown nodes defined in module.
|
String |
getYangVersion()
Returns the YANG version.
|
getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses
getModuleSourcePath
getName, getNamespace, getQNameModule, getRevision, getSemanticVersion
getNotifications
static final SemVer DEFAULT_SEMANTIC_VERSION
String getPrefix()
prefix
keywordString getYangVersion()
yang-version
keywordString getDescription()
description
keywordString getReference()
reference
keywordString getOrganization()
organization
keywordString getContact()
contact
keywordSet<ModuleImport> getImports()
import
keywords.Set<FeatureDefinition> getFeatures()
FeatureDefinition
instances which contain data from
feature statements defined in the module.
The feature is used to define a mechanism by which portions of the schema
are marked as conditional.feature
keywords.Set<AugmentationSchema> getAugmentations()
AugmentationSchema
instances which contain data from
augment statements defined in the module.augment
keyword and are
lexicographically orderedSet<RpcDefinition> getRpcs()
RpcDefinition
instances which contain data from
rpc statements defined in the module.rpc
keywords and are lexicographicaly
orderedSet<Deviation> getDeviations()
Deviation
instances which contain data from
deviation statements defined in the module.Set<IdentitySchemaNode> getIdentities()
IdentitySchemaNode
instances which contain data from
identity statements defined in the module.identity
keywords and are
lexicographically orderedList<ExtensionDefinition> getExtensionSchemaNodes()
ExtensionDefinition
instances which contain data
from extension statements defined in the module.extension
keyword and are
lexicographically ordered@Nonnull List<UnknownSchemaNode> getUnknownSchemaNodes()
@Deprecated @Nullable String getSource()
SchemaRepository.getSchemaSource(org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier, Class)
instead.Copyright © 2018 OpenDaylight. All rights reserved.