org.opendaylight.yangtools.yang.parser.stmt.reactor

Class RootStatementContext<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

java.lang.Object

org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase<A,D,E>

org.opendaylight.yangtools.yang.parser.stmt.reactor.RootStatementContext<A,D,E>

All Implemented Interfaces:

NamespaceBehaviour.NamespaceStorageNode, StmtContext<A,D,E>, StmtContext.Mutable<A,D,E>, StatementWriter.ResumedStatement

public class RootStatementContext<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>
extends StatementContextBase<A,D,E>

Root statement class for a YANG source. All statements defined in that YANG source are mapped underneath an instance of this class, hence recursive lookups from them cross this class.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext

StmtContext.Mutable<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Field Summary

Fields

Modifier and Type	Field and Description
static YangVersion	DEFAULT_VERSION

Method Summary

Modifier and Type	Method and Description
<K,N extends StatementNamespace<K,?,?>> void	addContextToNamespace(Class<N> type, K key, StmtContext<?,?,?> value) Associate a context with a key within a namespace.
void	addMutableStmtToSeal(MutableStatement mutableStatement) Add mutable statement to seal.
void	addRequiredSource(SourceIdentifier dependency) Add required module.
<K,V,T extends K,U extends V,N extends IdentifierNamespace<K,V>> void	addToNs(Class<N> type, T key, U value) Associate a value with a key within a namespace.
<K,V,N extends IdentifierNamespace<K,V>> Map<K,V>	getAllFromCurrentStmtCtxNamespace(Class<N> type)
<K,V,N extends IdentifierNamespace<K,V>> Map<K,V>	getAllFromLocalStorage(Class<N> type)
<K,V,N extends IdentifierNamespace<K,V>> Map<K,V>	getAllFromNamespace(Class<N> type)
NamespaceBehaviour.Registry	getBehaviourRegistry() Return the registry of a source context.
<K,V,N extends IdentifierNamespace<K,V>> V	getFromLocalStorage(Class<N> type, K key)
<K,V,N extends IdentifierNamespace<K,V>> Optional<Map.Entry<K,V>>	getFromNamespace(Class<N> type, NamespaceKeyCriterion<K> criterion)
<K,V,T extends K,N extends IdentifierNamespace<K,V>> V	getFromNamespace(Class<N> type, T key) Return a value associated with specified key within a namespace.
StatementContextBase<?,?,?>	getParentContext() Return the parent statement context, or null if this is the root statement.
NamespaceBehaviour.NamespaceStorageNode	getParentNamespaceStorage()
RootStatementContext<?,?,?>	getRoot() Returns the model root for this statement.
YangVersion	getRootVersion() Return version of root statement context.
Optional<SchemaPath>	getSchemaPath() Return the SchemaPath of this statement.
A	getStatementArgument() Return the statement argument.
NamespaceBehaviour.StorageNodeType	getStorageNodeType() Return local namespace behaviour type.
boolean	isConfiguration()
boolean	isEnabledSemanticVersioning()
protected boolean	isIgnoringConfig()
protected boolean	isIgnoringIfFeatures()
protected boolean	isParentSupportedByFeatures()
<K,V,N extends IdentifierNamespace<K,V>> V	putToLocalStorage(Class<N> type, K key, V value) Populate specified namespace with a key/value pair, overwriting previous contents.
<K,V,N extends IdentifierNamespace<K,V>> V	putToLocalStorageIfAbsent(Class<N> type, K key, V value) Populate specified namespace with a key/value pair unless the key is already associated with a value.
void	setRootIdentifier(SourceIdentifier identifier) Set identifier of current root context.
void	setRootVersion(YangVersion version) Set version of root statement context.

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase

addAsEffectOfStatement, addAsEffectOfStatement, addContext, addEffectiveSubstatement, addEffectiveSubstatements, addToStringAttributes, appendImplicitStatement, buildDeclared, buildEffective, checkLocalNamespaceAllowed, childCopyOf, createSubstatement, declaredSubstatements, definition, effectiveSubstatements, getCompletedPhase, getCopyHistory, getDefinition, getEffectOfStatement, getOriginalCtx, getPublicDefinition, getSourceReference, getStatementSource, getStatementSourceReference, isFullyDefined, isSupportedByFeatures, isSupportedToBuildEffective, mutableDeclaredSubstatements, mutableEffectiveSubstatements, newInferenceAction, onNamespaceElementAdded, rawStatementArgument, removeStatementFromEffectiveSubstatements, removeStatementFromEffectiveSubstatements, removeStatementsFromEffectiveSubstatements, setCompletedPhase, setIsSupportedToBuildEffective, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable

addToNs, childCopyOf, coerceParentContext

Methods inherited from interface org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext

allSubstatements, allSubstatementsStream, coerceRawStatementArgument, coerceStatementArgument, getAllFromCurrentStmtCtxNamespace, getAllFromNamespace, getFromNamespace

Field Detail

DEFAULT_VERSION

public static final YangVersion DEFAULT_VERSION

Method Detail

getParentContext

public StatementContextBase<?,?,?> getParentContext()

Description copied from interface: StmtContext

Return the parent statement context, or null if this is the root statement.

Specified by:

getParentContext in interface StmtContext<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Specified by:

getParentContext in interface StmtContext.Mutable<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Specified by:

getParentContext in class StatementContextBase<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Returns:

context of parent of statement, or null if this is the root statement.

getParentNamespaceStorage

public NamespaceBehaviour.NamespaceStorageNode getParentNamespaceStorage()

Specified by:

getParentNamespaceStorage in interface NamespaceBehaviour.NamespaceStorageNode

getBehaviourRegistry

public NamespaceBehaviour.Registry getBehaviourRegistry()

Return the registry of a source context.

Returns:

registry of source context

getStorageNodeType

public NamespaceBehaviour.StorageNodeType getStorageNodeType()

Description copied from interface: NamespaceBehaviour.NamespaceStorageNode

Return local namespace behaviour type.

Returns:

local namespace behaviour type NamespaceBehaviour

getRoot

public RootStatementContext<?,?,?> getRoot()

Description copied from class: StatementContextBase

Returns the model root for this statement.

Specified by:

getRoot in interface StmtContext<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Specified by:

getRoot in interface StmtContext.Mutable<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Specified by:

getRoot in class StatementContextBase<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Returns:

root context of statement

getStatementArgument

public A getStatementArgument()

Description copied from interface: StmtContext

Return the statement argument.

Returns:

statement argument, or null if this statement does not have an argument

getSchemaPath

public Optional<SchemaPath> getSchemaPath()

Description copied from interface: StmtContext

Return the SchemaPath of this statement. Not all statements have a SchemaPath, in which case Optional.empty() is returned.

Returns:

Optional SchemaPath

isConfiguration

public boolean isConfiguration()

isEnabledSemanticVersioning

public boolean isEnabledSemanticVersioning()

putToLocalStorage

public <K,V,N extends IdentifierNamespace<K,V>> V putToLocalStorage(Class<N> type,
                                                                    K key,
                                                                    V value)

Description copied from interface: NamespaceBehaviour.NamespaceStorageNode

Populate specified namespace with a key/value pair, overwriting previous contents. Similar to Map.put(Object, Object).

Specified by:

putToLocalStorage in interface NamespaceBehaviour.NamespaceStorageNode

Parameters:

type - Namespace identifier

key - Key

value - Value

Returns:

Previously-stored value, or null if the key was not present

getFromLocalStorage

public <K,V,N extends IdentifierNamespace<K,V>> V getFromLocalStorage(Class<N> type,
                                                                      K key)

Specified by:

getFromLocalStorage in interface NamespaceBehaviour.NamespaceStorageNode

getAllFromLocalStorage

public <K,V,N extends IdentifierNamespace<K,V>> Map<K,V> getAllFromLocalStorage(Class<N> type)

Specified by:

getAllFromLocalStorage in interface NamespaceBehaviour.NamespaceStorageNode

getRootVersion

public YangVersion getRootVersion()

Description copied from interface: StmtContext

Return version of root statement context.

Returns:

version of root statement context

setRootVersion

public void setRootVersion(YangVersion version)

Description copied from interface: StmtContext.Mutable

Set version of root statement context.

Parameters:

version - of root statement context

addMutableStmtToSeal

public void addMutableStmtToSeal(MutableStatement mutableStatement)

Description copied from interface: StmtContext.Mutable

Add mutable statement to seal. Each mutable statement must be sealed as the last step of statement parser processing.

Parameters:

mutableStatement - mutable statement which should be sealed

addRequiredSource

public void addRequiredSource(SourceIdentifier dependency)

Description copied from interface: StmtContext.Mutable

Add required module. Based on these dependencies are collected required sources from library sources.

Parameters:

dependency - SourceIdentifier of module required by current root context

setRootIdentifier

public void setRootIdentifier(SourceIdentifier identifier)

Description copied from interface: StmtContext.Mutable

Set identifier of current root context.

Parameters:

identifier - of current root context, must not be null

isIgnoringIfFeatures

protected boolean isIgnoringIfFeatures()

Specified by:

isIgnoringIfFeatures in class StatementContextBase<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

isIgnoringConfig

protected boolean isIgnoringConfig()

Specified by:

isIgnoringConfig in class StatementContextBase<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

isParentSupportedByFeatures

protected boolean isParentSupportedByFeatures()

Specified by:

isParentSupportedByFeatures in class StatementContextBase<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

getFromNamespace

public final <K,V,T extends K,N extends IdentifierNamespace<K,V>> V getFromNamespace(Class<N> type,
                                                                                     T key)

Return a value associated with specified key within a namespace.

Type Parameters:

K - namespace key type

V - namespace value type

N - namespace type

T - key type

Parameters:

type - Namespace type

key - Key

Returns:

Value, or null if there is no element

Throws:

NamespaceNotAvailableException - when the namespace is not available.

getFromNamespace

public final <K,V,N extends IdentifierNamespace<K,V>> Optional<Map.Entry<K,V>> getFromNamespace(Class<N> type,
                                                                                                NamespaceKeyCriterion<K> criterion)

getAllFromNamespace

public final <K,V,N extends IdentifierNamespace<K,V>> Map<K,V> getAllFromNamespace(Class<N> type)

getAllFromCurrentStmtCtxNamespace

public final <K,V,N extends IdentifierNamespace<K,V>> Map<K,V> getAllFromCurrentStmtCtxNamespace(Class<N> type)

addToNs

public final <K,V,T extends K,U extends V,N extends IdentifierNamespace<K,V>> void addToNs(Class<N> type,
                                                                                           T key,
                                                                                           U value)

Associate a value with a key within a namespace.

Type Parameters:

K - namespace key type

V - namespace value type

N - namespace type

T - key type

U - value type

Parameters:

type - Namespace type

key - Key

value - value

Throws:

NamespaceNotAvailableException - when the namespace is not available.

addContextToNamespace

public final <K,N extends StatementNamespace<K,?,?>> void addContextToNamespace(Class<N> type,
                                                                                K key,
                                                                                StmtContext<?,?,?> value)

Associate a context with a key within a namespace.

Type Parameters:

K - namespace key type

N - namespace type

Parameters:

type - Namespace type

key - Key

value - Context value

Throws:

NamespaceNotAvailableException - when the namespace is not available.

putToLocalStorageIfAbsent

public <K,V,N extends IdentifierNamespace<K,V>> V putToLocalStorageIfAbsent(Class<N> type,
                                                                            K key,
                                                                            V value)

Description copied from interface: NamespaceBehaviour.NamespaceStorageNode

Populate specified namespace with a key/value pair unless the key is already associated with a value. Similar to Map.putIfAbsent(Object, Object).

Specified by:

putToLocalStorageIfAbsent in interface NamespaceBehaviour.NamespaceStorageNode

Parameters:

type - Namespace identifier

key - Key

value - Value

Returns:

Preexisting value or null if there was no previous mapping