org.opendaylight.yangtools.yang.parser.spi.meta

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

All Superinterfaces:

StmtContext<A,D,E>

All Known Implementing Classes:

RootStatementContext, StatementContextBase

Enclosing interface:

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

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

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

Method Summary

Modifier and Type	Method and Description
void	addAsEffectOfStatement(Collection<? extends StmtContext<?,?,?>> ctxs)
void	addAsEffectOfStatement(StmtContext<?,?,?> ctx)
<K,KT extends K,N extends StatementNamespace<K,?,?>> void	addContext(Class<N> namespace, KT key, StmtContext<?,?,?> stmt) adds statement to namespace map with the key
void	addMutableStmtToSeal(MutableStatement mutableStatement) Add mutable statement to seal.
void	addRequiredModule(ModuleIdentifier dependency) Add required module.
<K,V,KT extends K,VT extends V,N extends IdentifierNamespace<K,V>> void	addToNs(Class<N> type, KT key, VT value)
StmtContext.Mutable<?,?,?>	getParentContext() Return the parent statement context, or null if this is the root statement.
StmtContext.Mutable<?,?,?>	getRoot()
Collection<? extends StmtContext.Mutable<?,?,?>>	mutableDeclaredSubstatements()
Collection<? extends StmtContext.Mutable<?,?,?>>	mutableEffectiveSubstatements()
ModelActionBuilder	newInferenceAction(ModelProcessingPhase phase) Create a new inference action to be executed during specified phase.
void	setCompletedPhase(ModelProcessingPhase completedPhase)
void	setIsSupportedToBuildEffective(boolean isSupportedToBuild)
void	setRootIdentifier(ModuleIdentifier identifier) Set identifier of current root context.
void	setRootVersion(YangVersion version) Set version of root statement context.

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

buildDeclared, buildEffective, createCopy, createCopy, declaredSubstatements, effectiveSubstatements, getAllFromCurrentStmtCtxNamespace, getAllFromNamespace, getCompletedPhase, getCopyHistory, getEffectOfStatement, getFromNamespace, getOriginalCtx, getPublicDefinition, getRootVersion, getSchemaPath, getStatementArgument, getStatementSource, getStatementSourceReference, isConfiguration, isEnabledSemanticVersioning, isSupportedByFeatures, isSupportedToBuildEffective, rawStatementArgument

Method Detail

getParentContext

StmtContext.Mutable<?,?,?> 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>>

Returns:

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

addToNs

<K,V,KT extends K,VT extends V,N extends IdentifierNamespace<K,V>> void addToNs(Class<N> type,
                                                                                KT key,
                                                                                VT value)
                                                                         throws NamespaceNotAvailableException

Throws:

NamespaceNotAvailableException

getRoot

@Nonnull
StmtContext.Mutable<?,?,?> getRoot()

Specified by:

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

mutableDeclaredSubstatements

@Nonnull
Collection<? extends StmtContext.Mutable<?,?,?>> mutableDeclaredSubstatements()

mutableEffectiveSubstatements

@Nonnull
Collection<? extends StmtContext.Mutable<?,?,?>> mutableEffectiveSubstatements()

newInferenceAction

@Nonnull
ModelActionBuilder newInferenceAction(@Nonnull
                                               ModelProcessingPhase phase)

Create a new inference action to be executed during specified phase. The action cannot be cancelled and will be executed even if its definition remains incomplete.

Parameters:

phase - Target phase in which the action will resolved.

Returns:

A new action builder.

Throws:

NullPointerException - if the specified phase is null

addContext

<K,KT extends K,N extends StatementNamespace<K,?,?>> void addContext(Class<N> namespace,
                                                                     KT key,
                                                                     StmtContext<?,?,?> stmt)

adds statement to namespace map with the key

Parameters:

namespace - StatementNamespace child that determines namespace to be added to

key - of type according to namespace class specification

stmt - to be added to namespace map

setRootVersion

void setRootVersion(YangVersion version)

Set version of root statement context.

Parameters:

version - of root statement context

addMutableStmtToSeal

void addMutableStmtToSeal(MutableStatement mutableStatement)

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

addRequiredModule

void addRequiredModule(ModuleIdentifier dependency)

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

Parameters:

dependency - ModuleIdentifier of module required by current root context

addAsEffectOfStatement

void addAsEffectOfStatement(StmtContext<?,?,?> ctx)

addAsEffectOfStatement

void addAsEffectOfStatement(Collection<? extends StmtContext<?,?,?>> ctxs)

setRootIdentifier

void setRootIdentifier(ModuleIdentifier identifier)

Set identifier of current root context.

Parameters:

identifier - of current root context

setIsSupportedToBuildEffective

void setIsSupportedToBuildEffective(boolean isSupportedToBuild)

setCompletedPhase

void setCompletedPhase(ModelProcessingPhase completedPhase)