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

Interface CommonStmtCtx

All Known Subinterfaces:

BoundStmtCtx<A>, BoundStmtCtxCompat<A,D>, EffectiveStmtCtx, EffectiveStmtCtx.Current<A,D>, EffectiveStmtCtx.Parent, EffectiveStmtCtx.UndeclaredCurrent<A,D>, NamespaceStmtCtx, RootStmtContext<A,D,E>, RootStmtContext.Mutable<A,D,E>, StmtContext<A,D,E>, StmtContext.Mutable<A,D,E>, StmtContextCompat

All Known Implementing Classes:

RootStatementContext

@Beta
public interface CommonStmtCtx

Common interface for all statement contexts, exposing information which is always available. Note this includes only stateless information -- hence we have rawArgument() but do not have an equivalent argument().

Method Summary

Modifier and Type	Method	Description
default @NonNull String	getRawArgument()	Return the statement argument in literal format.
default <D extends DeclaredStatement<?>> boolean	producesDeclared(Class<? super D> type)	Return true if this context produces specified DeclaredStatement representation.
default <E extends EffectiveStatement<?, ?>> boolean	producesEffective(Class<? super E> type)	Return true if this context produces specified EffectiveStatement representation.
@NonNull StatementDefinition	publicDefinition()	See StatementSupport.getPublicView().
@Nullable String	rawArgument()	Return the statement argument in literal format.
@NonNull StatementSourceReference	sourceReference()	Returns a reference to statement source.

Method Details

publicDefinition

@NonNull StatementDefinition publicDefinition()

See StatementSupport.getPublicView().

producesDeclared

default <D extends DeclaredStatement<?>> boolean producesDeclared(Class<? super D> type)

Return true if this context produces specified DeclaredStatement representation.

Type Parameters:

D - Declared Statement representation

Parameters:

type - DeclaredStatement representation

Returns:

True if this context results in specified DeclaredStatement representation

producesEffective

default <E extends EffectiveStatement<?,
?>> boolean producesEffective(Class<? super E> type)

Return true if this context produces specified EffectiveStatement representation.

Type Parameters:

E - Effective Statement representation

Parameters:

type - EffectiveStatement representation

Returns:

True if this context results in specified EffectiveStatement representation

sourceReference

@NonNull StatementSourceReference sourceReference()

Returns a reference to statement source.

Returns:

reference of statement source

rawArgument

@Nullable String rawArgument()

Return the statement argument in literal format.

Returns:

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

getRawArgument

default @NonNull String getRawArgument()

Return the statement argument in literal format.

Returns:

raw statement argument string

Throws:

VerifyException - if this statement does not have an argument