org.opendaylight.yangtools.yang.model.api

Interface SchemaContext

All Superinterfaces:

ActionNodeContainer, AugmentationTarget, ContainerSchemaNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, NotificationNodeContainer, SchemaNode

All Known Implementing Classes:

AbstractSchemaContext, EffectiveSchemaContext, FilteringSchemaContextProxy

@Immutable
public interface SchemaContext
extends ContainerSchemaNode

The interface represents static view of compiled yang files, contains the methods for obtaining all the top level context data (data from all modules) like YANG notifications, extensions, operations... Instances MUST be immutable and thus usage in multi threaded environment is safe.

Nested Class Summary

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

DocumentedNode.WithStatus

Field Summary

Fields

Modifier and Type	Field and Description
static QName	NAME QName of NETCONF top-level data node.

Method Summary

Modifier and Type	Method and Description
Module	findModuleByName(String name, Date revision) Returns module instance (from the context) with concrete name and revision date.
default Set<Module>	findModuleByNamespace(URI namespace) Returns module instance (from the context) with concrete namespace.
default Module	findModuleByNamespaceAndRevision(URI namespace, Date revision) Returns module instance based on given namespace and revision.
Set<ModuleIdentifier>	getAllModuleIdentifiers() Get all module and submodule identifiers.
Set<DataSchemaNode>	getDataDefinitions() Returns data schema node instances which represents direct subnodes (like leaf, leaf-list, list, container) in all YANG modules in the context.
Set<ExtensionDefinition>	getExtensions() Returns extencion definition instances which are defined as the direct subelements in all YANG modules in the context
Set<Module>	getModules() Returns modules which are part of the schema context.
com.google.common.base.Optional<String>	getModuleSource(ModuleIdentifier moduleIdentifier) Get yang source code represented as string for matching ModuleIdentifier.
Set<RpcDefinition>	getOperations() Returns rpc definition instances which are defined as the direct subelements in all YANG modules in the context.

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

isPresenceContainer

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

getAvailableAugmentations

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

getConstraints, isAddedByUses, isAugmenting, isConfiguration

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

getPath, getQName

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

getStatus

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

getDescription, getReference, getUnknownSchemaNodes

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

getNotifications

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

getActions

Field Detail

NAME

static final QName NAME

QName of NETCONF top-level data node.

Method Detail

getDataDefinitions

Set<DataSchemaNode> getDataDefinitions()

Returns data schema node instances which represents direct subnodes (like leaf, leaf-list, list, container) in all YANG modules in the context.

Returns:

set of DataSchemaNode instances which represents YANG data nodes at the module top level

getModules

Set<Module> getModules()

Returns modules which are part of the schema context.

Returns:

set of the modules which belong to the schema context

getOperations

Set<RpcDefinition> getOperations()

Returns rpc definition instances which are defined as the direct subelements in all YANG modules in the context.

Returns:

set of RpcDefinition instances which represents nodes defined via rpc YANG keyword

getExtensions

Set<ExtensionDefinition> getExtensions()

Returns extencion definition instances which are defined as the direct subelements in all YANG modules in the context

Returns:

set of ExtensionDefinition instances which represents nodes defined via extension YANG keyword

findModuleByName

Module findModuleByName(String name,
                        Date revision)

Returns module instance (from the context) with concrete name and revision date.

Parameters:

name - string with the module name

revision - date of the module revision

Returns:

module instance which has name and revision (if specified) the same as are the values specified in parameters name and revision. In other cases the null value is returned.

findModuleByNamespace

default Set<Module> findModuleByNamespace(URI namespace)

Returns module instance (from the context) with concrete namespace.

Parameters:

namespace - URI instance with specified namespace

Returns:

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

findModuleByNamespaceAndRevision

default Module findModuleByNamespaceAndRevision(URI namespace,
                                                Date revision)

Returns module instance based on given namespace and revision. If revision is not specified, returns module with newest revision.

Parameters:

namespace -

revision -

Returns:

Matching module or null if a match is not found

getModuleSource

com.google.common.base.Optional<String> getModuleSource(ModuleIdentifier moduleIdentifier)

Get yang source code represented as string for matching ModuleIdentifier.

Parameters:

moduleIdentifier - must provide a non-null ModuleIdentifier.getName(), other methods might return null.

Returns:

value iif matching module is found in schema context.

getAllModuleIdentifiers

Set<ModuleIdentifier> getAllModuleIdentifiers()

Get all module and submodule identifiers.