org.opendaylight.yangtools.yang.model.api

Interface Module

All Superinterfaces:

DataNodeContainer, DocumentedNode, NamespaceRevisionAware, NotificationNodeContainer

All Known Implementing Classes:

AbstractEffectiveModule

@Immutable
public interface Module
extends DataNodeContainer, DocumentedNode, NotificationNodeContainer, NamespaceRevisionAware

This interface contains the methods for getting the data from the YANG module.

Example of YANG module
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" { ;
}
}

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method and Description
Set<AugmentationSchemaNode>	getAugmentations() Returns AugmentationSchema instances which contain data from augment statements defined in the module.
Optional<String>	getContact() Returns the module contact.
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	getName() Returns the name of the module which is specified as argument of YANG module keyword.
default URI	getNamespace() Returns the namespace of the module which is specified as argument of YANG namespace keyword.
Optional<String>	getOrganization() Returns the module organization.
String	getPrefix() Returns the prefix of the module.
QNameModule	getQNameModule() Returns a QNameModule, which contains the namespace and the revision of the module.
default Optional<Revision>	getRevision() Returns the revision date for the module.
Set<RpcDefinition>	getRpcs() Returns RpcDefinition instances which contain data from rpc statements defined in the module.
Optional<SemVer>	getSemanticVersion() Returns the semantic version of yang module.
Set<Module>	getSubmodules()
YangVersion	getYangVersion() Returns the YANG version.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DataNodeContainer

findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

getDescription, getReference, getUnknownSchemaNodes

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer

getNotifications

Method Detail

getName

String getName()

Returns the name of the module which is specified as argument of YANG module keyword.

Returns:

string with the name of the module

getQNameModule

QNameModule getQNameModule()

Returns a QNameModule, which contains the namespace and the revision of the module.

Returns:

QNameModule identifier.

getNamespace

default URI getNamespace()

Returns the namespace of the module which is specified as argument of YANG namespace keyword. If you need both namespace and revision, please consider using getQNameModule().

Specified by:

getNamespace in interface NamespaceRevisionAware

Returns:

URI format of the namespace of the module

getRevision

default Optional<Revision> getRevision()

Returns the revision date for the module. If you need both namespace and revision, please consider using getQNameModule().

Specified by:

getRevision in interface NamespaceRevisionAware

Returns:

date of the module revision which is specified as argument of YANG revison keyword

getSemanticVersion

Optional<SemVer> getSemanticVersion()

Returns the semantic version of yang module.

If the semantic version is not specified, default semantic version of module is returned.

Returns:

SemVer semantic version of yang module which is specified as argument of (urn:opendaylight:yang:extension:semantic-version?revision =2016-02-02)semantic-version statement

getPrefix

String getPrefix()

Returns the prefix of the module.

Returns:

string with the module prefix which is specified as argument of YANG prefix keyword

getYangVersion

YangVersion getYangVersion()

Returns the YANG version.

Returns:

YANG version of this module.

getOrganization

Optional<String> getOrganization()

Returns the module organization.

Returns:

string with the name of the organization specified in the module as the argument of YANG organization keyword

getContact

Optional<String> getContact()

Returns the module contact.

The contact represents the person or persons to whom technical queries concerning this module should be sent, such as their name, postal address, telephone number, and electronic mail address.

Returns:

string with the contact data specified in the module as the argument of YANG contact keyword

getImports

Set<ModuleImport> getImports()

Returns imports which represents YANG modules which are imported to this module via import statement.

Returns:

set of module imports which are specified in the module as the argument of YANG import keywords.

getSubmodules

Set<Module> getSubmodules()

getFeatures

Set<FeatureDefinition> getFeatures()

Returns 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.

Returns:

feature statements in lexicographical order which are specified in the module as the argument of YANG feature keywords.

getAugmentations

Set<AugmentationSchemaNode> getAugmentations()

Returns AugmentationSchema instances which contain data from augment statements defined in the module.

Returns:

set of the augmentation schema instances which are specified in the module as YANG augment keyword and are lexicographically ordered

getRpcs

Set<RpcDefinition> getRpcs()

Returns RpcDefinition instances which contain data from rpc statements defined in the module.

Returns:

set of the rpc definition instances which are specified in the module as YANG rpc keywords and are lexicographicaly ordered

getDeviations

Set<Deviation> getDeviations()

Returns Deviation instances which contain data from deviation statements defined in the module.

Returns:

set of the deviation instances

getIdentities

Set<IdentitySchemaNode> getIdentities()

Returns IdentitySchemaNode instances which contain data from identity statements defined in the module.

Returns:

set of identity schema node instances which are specified in the module as YANG identity keywords and are lexicographically ordered

getExtensionSchemaNodes

List<ExtensionDefinition> getExtensionSchemaNodes()

Returns ExtensionDefinition instances which contain data from extension statements defined in the module.

Returns:

set of extension definition instances which are specified in the module as YANG extension keyword and are lexicographically ordered