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
default Iterable<? extends StmtContext<?,?,?>>	allSubstatements()
default Stream<? extends StmtContext<?,?,?>>	allSubstatementsStream()
D	buildDeclared() Builds DeclaredStatement for statement context.
E	buildEffective() Builds EffectiveStatement for statement context.
default @NonNull StmtContext<?,?,?>	coerceParentContext() Return the parent statement context, forcing a VerifyException if this is the root statement.
default @NonNull String	coerceRawStatementArgument() Return the statement argument in literal format.
default A	coerceStatementArgument() Return the statement argument in literal format.
@NonNull Collection<? extends StmtContext<?,?,?>>	declaredSubstatements() Return declared substatements.
@NonNull 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,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.
Optional<StmtContext<?,?,?>>	getOriginalCtx()
@Nullable StmtContext<?,?,?>	getParentContext() Return the parent statement context, or null if this is the root statement.
@NonNull StatementDefinition	getPublicDefinition()
@NonNull StmtContext<?,?,?>	getRoot()
@NonNull YangVersion	getRootVersion() Return version of root statement context.
@NonNull Optional<SchemaPath>	getSchemaPath() Return the SchemaPath of this statement.
A	getStatementArgument() Return the statement argument.
@NonNull StatementSource	getStatementSource()
@NonNull StatementSourceReference	getStatementSourceReference()
boolean	isConfiguration()
boolean	isEnabledSemanticVersioning()
boolean	isSupportedByFeatures()
boolean	isSupportedToBuildEffective()
@Nullable String	rawStatementArgument() Return the statement argument in literal format.

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.

coerceParentContext

default @NonNull StmtContext<?,?,?> coerceParentContext()

Return the parent statement context, forcing a VerifyException if this is the root statement.

Returns:

context of parent of statement

Throws:

com.google.common.base.VerifyException - if this statement is the root statement

rawStatementArgument

@Nullable String rawStatementArgument()

Return the statement argument in literal format.

Returns:

raw statement argument string, or null if this statement does not have an argument.

coerceRawStatementArgument

default @NonNull String coerceRawStatementArgument()

Return the statement argument in literal format.

Returns:

raw statement argument string

Throws:

com.google.common.base.VerifyException - if this statement does not have an argument

getStatementArgument

A getStatementArgument()

Return the statement argument.

Returns:

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

coerceStatementArgument

default A coerceStatementArgument()

Return the statement argument in literal format.

Returns:

raw statement argument string

Throws:

com.google.common.base.VerifyException - if this statement does not have an argument

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

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

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

allSubstatements

default Iterable<? extends StmtContext<?,?,?>> allSubstatements()

allSubstatementsStream

default Stream<? extends StmtContext<?,?,?>> allSubstatementsStream()

buildDeclared

D buildDeclared()

Builds DeclaredStatement for statement context.

buildEffective

E buildEffective()

Builds EffectiveStatement for statement context.

isSupportedToBuildEffective

boolean isSupportedToBuildEffective()

getEffectOfStatement

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

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