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

Interface ModuleEffectiveStatement

All Superinterfaces:

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

public non-sealed interface ModuleEffectiveStatement
extends DataTreeAwareEffectiveStatement<UnresolvedQName.Unqualified,ModuleStatement>, RootEffectiveStatement<ModuleStatement>, TypedefAwareEffectiveStatement<UnresolvedQName.Unqualified,ModuleStatement>, SchemaTreeRoot

Effective view of a module statement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ModuleEffectiveStatement.ConformanceType	Conformance type, as defined by RFC7895 and indirectly referenced in RFC7950.

Method Summary

Modifier and Type	Method	Description
@NonNull ModuleEffectiveStatement.ConformanceType	conformance()	Return the conformance type of this module.
default @NonNull Collection<ExtensionEffectiveStatement>	extensions()	Namespace of available extensions.
default @NonNull Collection<FeatureEffectiveStatement>	features()	Namespace of available features.
@NonNull Optional<ExtensionEffectiveStatement>	findExtension(@NonNull QName qname)	Lookup an ExtensionEffectiveStatement by its QName.
@NonNull Optional<FeatureEffectiveStatement>	findFeature(@NonNull QName qname)	Lookup an FeatureEffectiveStatement by its QName.
@NonNull Optional<IdentityEffectiveStatement>	findIdentity(@NonNull QName qname)	Lookup an IdentityEffectiveStatement by its QName.
default Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(SchemaNodeIdentifier path)	Find a schema tree node based on its schema node identifier.
@NonNull Optional<SubmoduleEffectiveStatement>	findSubmodule(@NonNull UnresolvedQName.Unqualified submoduleName)	Namespace mapping all included submodules.
default @NonNull Collection<IdentityEffectiveStatement>	identities()	Namespace of available identities.
@NonNull QNameModule	localQNameModule()	Get the local QNameModule of this module.
default @NonNull NamespaceEffectiveStatement	namespace()	Return this statement's namespace substatement.
default @NonNull PrefixEffectiveStatement	prefix()	Return this statement's prefix substatement.
default StatementDefinition	statementDefinition()	Statement Definition of this statement.
default @NonNull Collection<SubmoduleEffectiveStatement>	submodules()	All submodules included in this module, directly or transitively.

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

dataTreeNodes, findDataTreeNode, findDataTreeNode

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

collectEffectiveSubstatements, effectiveSubstatements, findFirstEffectiveSubstatement, findFirstEffectiveSubstatementArgument, 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.RootEffectiveStatement

findNamespacePrefix, findReachableModule, namespacePrefixes, reachableModules

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

findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, findSchemaTreeNode, schemaTreeNodes

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

findSchemaTreeNode

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

findTypedef, typedefs

Method Details

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.

namespace

default @NonNull NamespaceEffectiveStatement namespace()

Return this statement's namespace substatement.

Returns:

A NamespaceEffectiveStatement

Implementation Requirements:

Default implementation uses EffectiveStatement.findFirstEffectiveSubstatement(Class) and throws a VerifyException if a matching substatement is not found.

prefix

default @NonNull PrefixEffectiveStatement prefix()

Return this statement's prefix substatement.

Returns:

A PrefixEffectiveStatement

Implementation Requirements:

Default implementation uses EffectiveStatement.findFirstEffectiveSubstatement(Class) and throws a VerifyException if a matching substatement is not found.

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.

extensions

default @NonNull Collection<ExtensionEffectiveStatement> extensions()

Namespace of available extensions. According to RFC7950 section 6.2.1:

     All extension names defined in a module and its submodules share
     the same extension identifier namespace.
 

Returns:

All ExtensionEffectiveStatements defined in this module

findExtension

@NonNull Optional<ExtensionEffectiveStatement> findExtension(@NonNull QName qname)

Lookup an ExtensionEffectiveStatement by its QName.

Parameters:

qname - identity name

Returns:

Corresponding extension, or empty

Throws:

NullPointerException - if qname is null

features

default @NonNull Collection<FeatureEffectiveStatement> features()

Namespace of available features. According to RFC7950 section 6.2.1:

     All feature names defined in a module and its submodules share the
     same feature identifier namespace.
 

Returns:

All FeatureEffectiveStatements defined in this module

findFeature

@NonNull Optional<FeatureEffectiveStatement> findFeature(@NonNull QName qname)

Lookup an FeatureEffectiveStatement by its QName.

Parameters:

qname - identity name

Returns:

Corresponding feature, or empty

Throws:

NullPointerException - if qname is null

identities

default @NonNull Collection<IdentityEffectiveStatement> identities()

Namespace of available identities. According to RFC7950 section 6.2.1:

     All identity names defined in a module and its submodules share
     the same identity identifier namespace.
 

Returns:

All IdentityEffectiveStatements defined in this module

findIdentity

@NonNull Optional<IdentityEffectiveStatement> findIdentity(@NonNull QName qname)

Lookup an IdentityEffectiveStatement by its QName.

Parameters:

qname - identity name

Returns:

Corresponding identity, or empty

Throws:

NullPointerException - if qname is null

submodules

default @NonNull Collection<SubmoduleEffectiveStatement> submodules()

All submodules included in this module, directly or transitively.

Returns:

All included submodules

findSubmodule

@NonNull Optional<SubmoduleEffectiveStatement> findSubmodule(@NonNull UnresolvedQName.Unqualified submoduleName)

Namespace mapping all included submodules. The namespaces is keyed by submodule name, as represented by ModelStatement.argument().

Returns:

submoduleName Included submodule, or empty

Throws:

NullPointerException - if submoduleName is null