org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective

Class ModuleEffectiveStatementImpl

java.lang.Object

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.DeclaredEffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AbstractEffectiveDocumentedNode<String,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ModuleEffectiveStatementImpl

All Implemented Interfaces:

DataNodeContainer, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatement<String,ModuleStatement>, ModelStatement<String>, Module, ModuleIdentifier, NotificationNodeContainer, SourceStreamAware, MutableStatement

public final class ModuleEffectiveStatementImpl
extends AbstractEffectiveDocumentedNode<String,D>

Nested Class Summary

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

DocumentedNode.WithStatus

Field Summary

Fields inherited from interface org.opendaylight.yangtools.yang.model.api.Module

DEFAULT_SEMANTIC_VERSION

Constructor Summary

Constructors

Constructor and Description
ModuleEffectiveStatementImpl(StmtContext<String,ModuleStatement,EffectiveStatement<String,ModuleStatement>> ctx)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<AugmentationSchema>	getAugmentations() Returns AugmentationSchema instances which contain data from augment statements defined in the module.
Set<DataSchemaNode>	getChildNodes() Returns set of all child nodes defined within this DataNodeContainer.
String	getContact() Returns the module contact.
DataSchemaNode	getDataChildByName(QName name)
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<GroupingDefinition>	getGroupings() Returns set of all groupings defined within this DataNodeContainer.
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	getModuleSourcePath() Get descriptive source path (usually file path) from which this module was parsed.
String	getName() Returns the name of the module which is specified as argument of YANG module keyword
URI	getNamespace() Returns the namespace of the module which is specified as argument of YANG namespace keyword.
Set<NotificationDefinition>	getNotifications() All implementations should override this method.
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.
Date	getRevision() Returns the revision date for the module.
Set<RpcDefinition>	getRpcs() Returns RpcDefinition instances which contain data from rpc statements defined in the module.
SemVer	getSemanticVersion() Returns the semantic version of yang module.
String	getSource() Get YANG source.
Set<Module>	getSubmodules()
Set<TypeDefinition<?>>	getTypeDefinitions() Returns set of all newly defined types within this DataNodeContainer.
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown nodes defined in module.
Set<UsesNode>	getUses()
String	getYangVersion() Returns the YANG version.
int	hashCode()
void	seal() Finish statement and make it immutable.
String	toString()

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AbstractEffectiveDocumentedNode

getDescription, getReference, getStatus

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.DeclaredEffectiveStatementBase

argument, getDeclared, getStatementSource, statementDefinition

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase

allSubstatementsOfType, effectiveSubstatements, firstEffective, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, get, getAll

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getDescription, getReference

Constructor Detail

ModuleEffectiveStatementImpl

public ModuleEffectiveStatementImpl(StmtContext<String,ModuleStatement,EffectiveStatement<String,ModuleStatement>> ctx)

Method Detail

getQNameModule

public QNameModule getQNameModule()

Description copied from interface: ModuleIdentifier

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

Returns:

QNameModule identifier.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getModuleSourcePath

public String getModuleSourcePath()

Description copied from interface: SourceStreamAware

Get descriptive source path (usually file path) from which this module was parsed.

Specified by:

getModuleSourcePath in interface SourceStreamAware

getSource

public String getSource()

Description copied from interface: Module

Get YANG source.

Specified by:

getSource in interface Module

Returns:

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

getNamespace

public URI getNamespace()

Description copied from interface: ModuleIdentifier

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 ModuleIdentifier.getQNameModule().

Specified by:

getNamespace in interface ModuleIdentifier

Returns:

URI format of the namespace of the module

getName

public String getName()

Description copied from interface: ModuleIdentifier

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

Specified by:

getName in interface ModuleIdentifier

Returns:

string with the name of the module

getRevision

public Date getRevision()

Description copied from interface: ModuleIdentifier

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

Specified by:

getRevision in interface ModuleIdentifier

Returns:

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

getPrefix

public String getPrefix()

Description copied from interface: Module

Returns the prefix of the module

Specified by:

getPrefix in interface Module

Returns:

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

getYangVersion

public String getYangVersion()

Description copied from interface: Module

Returns the YANG version. Default value is 1.

Specified by:

getYangVersion in interface Module

Returns:

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

getOrganization

public String getOrganization()

Description copied from interface: Module

Returns the module organization.

Specified by:

getOrganization in interface Module

Returns:

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

getContact

public String getContact()

Description copied from interface: Module

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.

Specified by:

getContact in interface Module

Returns:

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

getImports

public Set<ModuleImport> getImports()

Description copied from interface: Module

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

Specified by:

getImports in interface Module

Returns:

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

getSubmodules

public Set<Module> getSubmodules()

Specified by:

getSubmodules in interface Module

getFeatures

public Set<FeatureDefinition> getFeatures()

Description copied from interface: Module

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.

Specified by:

getFeatures in interface Module

Returns:

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

getNotifications

public Set<NotificationDefinition> getNotifications()

Description copied from interface: NotificationNodeContainer

All implementations should override this method. The default definition of this method is used in YANG 1.0 (RFC6020) implementations of AugmentationSchema, GroupingDefinition, ListSchemaNode and ContainerSchemaNode which do not allow action statements. These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain notification statements. The default definition is also used by implementations of ContainerSchemaNode which do not support notification statements such as InputEffectiveStatementImpl and OutputEffectiveStatementImpl.

Specified by:

getNotifications in interface NotificationNodeContainer

Returns:

set of notification nodes

getAugmentations

public Set<AugmentationSchema> getAugmentations()

Description copied from interface: Module

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

Specified by:

getAugmentations in interface Module

Returns:

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

getRpcs

public Set<RpcDefinition> getRpcs()

Description copied from interface: Module

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

Specified by:

getRpcs in interface Module

Returns:

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

getDeviations

public Set<Deviation> getDeviations()

Description copied from interface: Module

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

Specified by:

getDeviations in interface Module

Returns:

set of the deviation instances

getExtensionSchemaNodes

public List<ExtensionDefinition> getExtensionSchemaNodes()

Description copied from interface: Module

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

Specified by:

getExtensionSchemaNodes in interface Module

Returns:

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

getIdentities

public Set<IdentitySchemaNode> getIdentities()

Description copied from interface: Module

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

Specified by:

getIdentities in interface Module

Returns:

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

getUnknownSchemaNodes

@Nonnull
public List<UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: Module

Returns unknown nodes defined in module.

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

Specified by:

getUnknownSchemaNodes in interface Module

Returns:

unknown nodes in lexicographical order

getTypeDefinitions

public final Set<TypeDefinition<?>> getTypeDefinitions()

Description copied from interface: DataNodeContainer

Returns set of all newly defined types within this DataNodeContainer.

Specified by:

getTypeDefinitions in interface DataNodeContainer

Returns:

typedef statements in lexicographical order

getChildNodes

public final Set<DataSchemaNode> getChildNodes()

Description copied from interface: DataNodeContainer

Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection, each node is guaranteed to be present at most once.

Specified by:

getChildNodes in interface DataNodeContainer

Returns:

child nodes in lexicographical order

getGroupings

public final Set<GroupingDefinition> getGroupings()

Description copied from interface: DataNodeContainer

Returns set of all groupings defined within this DataNodeContainer.

Specified by:

getGroupings in interface DataNodeContainer

Returns:

grouping statements in lexicographical order

getDataChildByName

public final DataSchemaNode getDataChildByName(QName name)

Specified by:

getDataChildByName in interface DataNodeContainer

Parameters:

name - QName of seeked child

Returns:

child node of this DataNodeContainer if child with given name is present, null otherwise

getUses

public Set<UsesNode> getUses()

Specified by:

getUses in interface DataNodeContainer

Returns:

Set of all uses nodes defined within this DataNodeContainer

getSemanticVersion

public SemVer getSemanticVersion()

Description copied from interface: ModuleIdentifier

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

Specified by:

getSemanticVersion in interface ModuleIdentifier

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

toString

public String toString()

Overrides:

toString in class Object

seal

public void seal()

Description copied from interface: MutableStatement

Finish statement and make it immutable. After this method is invoked, any further modifications of current object are not allowed.

Specified by:

seal in interface MutableStatement