Package org.opendaylight.yangtools.yang.model.api.stmt

Interface ModuleEffectiveStatement

All Superinterfaces:

DataTreeAwareEffectiveStatement<UnresolvedQName.Unqualified,ModuleStatement>, EffectiveStatement<UnresolvedQName.Unqualified,ModuleStatement>, ModelStatement<UnresolvedQName.Unqualified>, SchemaTreeAwareEffectiveStatement<UnresolvedQName.Unqualified,ModuleStatement>, SchemaTreeRoot

@Beta
public interface ModuleEffectiveStatement
extends DataTreeAwareEffectiveStatement<UnresolvedQName.Unqualified,ModuleStatement>, SchemaTreeRoot

Effective view of a ModuleStatement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ModuleEffectiveStatement.ConformanceType	Conformance type, as defined by RFC7895 and indirectly referenced in RFC7950.
static class	ModuleEffectiveStatement.NameToEffectiveSubmoduleNamespace	Namespace mapping all included submodules.
static class	ModuleEffectiveStatement.PrefixToEffectiveModuleNamespace	Namespace mapping all known prefixes in a module to their modules.
static class	ModuleEffectiveStatement.QNameModuleToPrefixNamespace	Namespace mapping all known QNameModules to their encoding prefixes.

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

DataTreeAwareEffectiveStatement.DataTreeNamespace

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

SchemaTreeAwareEffectiveStatement.SchemaTreeNamespace

Method Summary

Modifier and Type	Method	Description
@NonNull ModuleEffectiveStatement.ConformanceType	conformance()	Return the conformance type of this module.
default Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(SchemaNodeIdentifier path)	Find a schema tree node based on its schema node identifier.
@NonNull QNameModule	localQNameModule()	Get the local QNameModule of this module.
default StatementDefinition	statementDefinition()	Statement Definition of this statement.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.DataTreeAwareEffectiveStatement

findDataTreeNode, findDataTreeNode

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement

effectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, get, getAll, getDeclared, statementOrigin, streamEffectiveSubstatements

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.ModelStatement

argument

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeAwareEffectiveStatement

findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeRoot

findSchemaTreeNode

Method Detail

statementDefinition

default StatementDefinition statementDefinition()

Description copied from interface: ModelStatement

Statement Definition of this statement.

Specified by:

statementDefinition in interface ModelStatement<UnresolvedQName.Unqualified>

Returns:

definition of this statement.

findSchemaTreeNode

default Optional<SchemaTreeEffectiveStatement<?>> findSchemaTreeNode(SchemaNodeIdentifier path)

Find a schema tree node based on its schema node identifier.

Specified by:

findSchemaTreeNode in interface SchemaTreeRoot

Parameters:

path - Absolute schema node identifier

Returns:

Found node, or empty

Implementation Requirements:

Default implementation defers to SchemaTreeAwareEffectiveStatement.findSchemaTreeNode(java.util.List).

localQNameModule

@NonNull QNameModule localQNameModule()

Get the local QNameModule of this module. All implementations need to override this default method.

Returns:

Local QNameModule

conformance

@NonNull ModuleEffectiveStatement.ConformanceType conformance()

Return the conformance type of this module.

Returns:

Conformance type.