org.opendaylight.yangtools.yang.model.api

Interface Module

All Superinterfaces:

DataNodeContainer, ModuleIdentifier, NotificationNodeContainer, SourceStreamAware

All Known Implementing Classes:

ModuleEffectiveStatementImpl, SubmoduleEffectiveStatementImpl

@Immutable
public interface Module
extends DataNodeContainer, SourceStreamAware, ModuleIdentifier, NotificationNodeContainer

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" { ;
}
}

Field Summary

Fields

Modifier and Type	Field and Description
static SemVer	DEFAULT_SEMANTIC_VERSION Default semantic version of Module.

Method Summary

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() Deprecated. Use SchemaRepository.getSchemaSource( org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier, Class) instead.
Set<Module>	getSubmodules()
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown nodes defined in module.
String	getYangVersion() Returns the YANG version.

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

getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses

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

getModuleSourcePath

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

getName, getNamespace, getQNameModule, getRevision, getSemanticVersion

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

getNotifications

Field Detail

DEFAULT_SEMANTIC_VERSION

static final SemVer DEFAULT_SEMANTIC_VERSION

Default semantic version of Module.

Method Detail

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

String getYangVersion()

Returns the YANG version. Default value is 1.

Returns:

string with the module YANG version which is specified as argument of YANG yang-version keyword

getDescription

String getDescription()

Returns the module description.

Returns:

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

getReference

String getReference()

Returns the module reference.

Returns:

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

getOrganization

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

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<AugmentationSchema> 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

getUnknownSchemaNodes

@Nonnull
List<UnknownSchemaNode> getUnknownSchemaNodes()

Returns unknown nodes defined in module.

Returns:

unknown nodes in lexicographical order

getSource

@Deprecated
 @Nullable
String getSource()

Deprecated. Use SchemaRepository.getSchemaSource( org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier, Class) instead.

Get YANG source.

Returns:

YANG text of this module, or null if the source is not available.