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

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

All Known Subinterfaces:

StmtContext.Mutable<A,D,E>

All Known Implementing Classes:

RootStatementContext, StatementContextBase

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StmtContext.Mutable<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Method Summary

Modifier and Type	Method and Description
D	buildDeclared() Builds DeclaredStatement for statement context.
E	buildEffective() Builds EffectiveStatement for statement context
StmtContext.Mutable<A,D,E>	createCopy(QNameModule newQNameModule, StatementContextBase<?,?,?> newParent, CopyType typeOfCopy)
StmtContext.Mutable<A,D,E>	createCopy(StatementContextBase<?,?,?> newParent, CopyType typeOfCopy)
Collection<? extends StmtContext<?,?,?>>	declaredSubstatements() Return declared substatements.
Collection<? extends StmtContext<?,?,?>>	effectiveSubstatements() Return effective substatements.
<K,V,N extends IdentifierNamespace<K,V>> Map<K,V>	getAllFromCurrentStmtCtxNamespace(Class<N> type)
<K,V,N extends IdentifierNamespace<K,V>> Map<K,V>	getAllFromNamespace(Class<N> type)
ModelProcessingPhase	getCompletedPhase()
CopyHistory	getCopyHistory()
Collection<? extends StmtContext<?,?,?>>	getEffectOfStatement()
<K,V,KT extends K,N extends IdentifierNamespace<K,V>> V	getFromNamespace(Class<N> type, KT key)
Optional<StmtContext<?,?,?>>	getOriginalCtx()
StmtContext<?,?,?>	getParentContext() Return the parent statement context, or null if this is the root statement.
StatementDefinition	getPublicDefinition()
StmtContext<?,?,?>	getRoot()
YangVersion	getRootVersion() Return version of root statement context.
Optional<SchemaPath>	getSchemaPath() Return the SchemaPath of this statement.
A	getStatementArgument()
StatementSource	getStatementSource()
StatementSourceReference	getStatementSourceReference()
boolean	isConfiguration()
boolean	isEnabledSemanticVersioning()
boolean	isSupportedByFeatures()
boolean	isSupportedToBuildEffective()
String	rawStatementArgument()

Method Detail

getStatementSource

@Nonnull
StatementSource getStatementSource()

getStatementSourceReference

@Nonnull
StatementSourceReference getStatementSourceReference()

getPublicDefinition

@Nonnull
StatementDefinition getPublicDefinition()

getParentContext

@Nullable
StmtContext<?,?,?> getParentContext()

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

Returns:

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

rawStatementArgument

@Nullable
String rawStatementArgument()

Returns:

raw statement argument string

getStatementArgument

@Nullable
A getStatementArgument()

getSchemaPath

@Nonnull
Optional<SchemaPath> getSchemaPath()

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

Returns:

Optional SchemaPath

isConfiguration

boolean isConfiguration()

isEnabledSemanticVersioning

boolean isEnabledSemanticVersioning()

getFromNamespace

@Nonnull
<K,V,KT extends K,N extends IdentifierNamespace<K,V>> V getFromNamespace(Class<N> type,
                                                                                  KT key)
                                                                           throws NamespaceNotAvailableException

Throws:

NamespaceNotAvailableException

getAllFromNamespace

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

getAllFromCurrentStmtCtxNamespace

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

getRoot

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

declaredSubstatements

@Nonnull
Collection<? extends StmtContext<?,?,?>> declaredSubstatements()

Return declared substatements. These are the statements which are explicitly written in the source model.

Returns:

Collection of declared substatements

effectiveSubstatements

@Nonnull
Collection<? extends StmtContext<?,?,?>> effectiveSubstatements()

Return effective substatements. These are the statements which are added as this statement's substatements complete their effective model phase.

Returns:

Collection of declared substatements

buildDeclared

D buildDeclared()

Builds DeclaredStatement for statement context.

buildEffective

E buildEffective()

Builds EffectiveStatement for statement context

isSupportedToBuildEffective

boolean isSupportedToBuildEffective()

getEffectOfStatement

Collection<? extends StmtContext<?,?,?>> getEffectOfStatement()

createCopy

StmtContext.Mutable<A,D,E> createCopy(StatementContextBase<?,?,?> newParent,
                                      CopyType typeOfCopy)

Returns:

copy of this considering CopyType (augment, uses)

Throws:

SourceException - instance of SourceException

createCopy

StmtContext.Mutable<A,D,E> createCopy(QNameModule newQNameModule,
                                      StatementContextBase<?,?,?> newParent,
                                      CopyType typeOfCopy)

Returns:

copy of this considering CopyType (augment, uses)

Throws:

SourceException - instance of SourceException

getCopyHistory

CopyHistory getCopyHistory()

isSupportedByFeatures

boolean isSupportedByFeatures()

getOriginalCtx

Optional<StmtContext<?,?,?>> getOriginalCtx()

getCompletedPhase

ModelProcessingPhase getCompletedPhase()

getRootVersion

@Nonnull
YangVersion getRootVersion()

Return version of root statement context.

Returns:

version of root statement context