Module org.opendaylight.yangtools.yang.model.api

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

Interface EffectiveModelContext

All Superinterfaces:

ActionNodeContainer, AddedByUsesAware, AugmentationTarget, ContainerLike, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, Immutable, MustConstraintAware, NotificationNodeContainer, SchemaContext, SchemaNode, SchemaTreeRoot, WhenConditionAware

@Beta
public interface EffectiveModelContext
extends SchemaContext, SchemaTreeRoot

EffectiveStatement-based result of YANG parser compilation. Unlike a SchemaContext, which it extends, it gives access to individual ModuleEffectiveStatements that comprise it. It also supports resolution of schema node identifiers via findSchemaTreeNode(SchemaNodeIdentifier).

Author:

Robert Varga

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

NAME

Method Summary

Modifier and Type	Method	Description
default @NonNull Optional<ModuleEffectiveStatement>	findModuleStatement(QName moduleName)
default @NonNull Optional<ModuleEffectiveStatement>	findModuleStatement(QNameModule moduleName)
default @NonNull Collection<@NonNull ModuleEffectiveStatement>	findModuleStatements(String name)	Returns module instances (from the context) with a concrete name.
default @NonNull Collection<@NonNull ModuleEffectiveStatement>	findModuleStatements(XMLNamespace namespace)	Returns module instance (from the context) with concrete namespace.
default Optional<SchemaTreeEffectiveStatement<?>>	findSchemaTreeNode(SchemaNodeIdentifier path)	Find a schema tree node based on its schema node identifier.
default @NonNull ModuleEffectiveStatement	getModuleStatement(QName moduleName)
default @NonNull ModuleEffectiveStatement	getModuleStatement(QNameModule moduleName)
@NonNull Map<QNameModule,ModuleEffectiveStatement>	getModuleStatements()

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

dataChildByName, findDataChildByName, findDataChildByName, findDataTreeChild, findDataTreeChild, getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions

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

isConfiguration

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

getUnknownSchemaNodes

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

getNotifications

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

effectiveConfig, findAction, findDataTreeChild, findModule, findModule, findModule, findModule, findModule, findModule, findModule, findModules, findModules, findNotification, getActions, getAvailableAugmentations, getDataDefinitions, getDerivedIdentities, getDescription, getExtensions, getModules, getMustConstraints, getOperations, getQName, getReference, getStatus, getUses, getWhenCondition, isAddedByUses, isAugmenting

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

findSchemaTreeNode

Method Details

getModuleStatements

@NonNull Map<QNameModule,ModuleEffectiveStatement> getModuleStatements()

findModuleStatement

default @NonNull Optional<ModuleEffectiveStatement> findModuleStatement(QNameModule moduleName)

findModuleStatement

default @NonNull Optional<ModuleEffectiveStatement> findModuleStatement(QName moduleName)

findModuleStatements

default @NonNull Collection<@NonNull ModuleEffectiveStatement> findModuleStatements(String name)

Returns module instances (from the context) with a concrete name. Returned collection is required to have its iteration order guarantee that the latest revision is encountered first.

Parameters:

name - string with the module name

Returns:

set of module instances with specified name.

findModuleStatements

default @NonNull Collection<@NonNull ModuleEffectiveStatement> findModuleStatements(XMLNamespace namespace)

Returns module instance (from the context) with concrete namespace. Returned collection is required to have its iteration order guarantee that the latest revision is encountered first.

Parameters:

namespace - XMLNamespace instance with specified namespace

Returns:

module instance which has namespace equal to the namespace or null in other cases

getModuleStatement

default @NonNull ModuleEffectiveStatement getModuleStatement(QNameModule moduleName)

getModuleStatement

default @NonNull ModuleEffectiveStatement getModuleStatement(QName moduleName)

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 locates the module corresponding to the first element of path and then defers to ModuleEffectiveStatement.findSchemaTreeNode(SchemaNodeIdentifier).