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

Interface EffectiveStmtCtx.Parent

All Superinterfaces:

CommonStmtCtx, EffectiveStmtCtx, Immutable, MutationBehaviour<Immutable>, StmtContextCompat

All Known Subinterfaces:

EffectiveStmtCtx.Current<A,D>

All Known Implementing Classes:

RootStatementContext, StatementContextBase

Enclosing interface:

EffectiveStmtCtx

@Beta
public static interface EffectiveStmtCtx.Parent
extends EffectiveStmtCtx

Minimum amount of parent state required to build an accurate effective view of a particular child. Child state is expressed as EffectiveStmtCtx.Current.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EffectiveStmtCtx.Parent.EffectiveConfig	Effective config statement value.

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

EffectiveStmtCtx.Current<A,D extends DeclaredStatement<A>>, EffectiveStmtCtx.Parent

Method Summary

Modifier and Type	Method	Description
@NonNull EffectiveStmtCtx.Parent.EffectiveConfig	effectiveConfig()	Return the effective config statement value.
@NonNull QNameModule	effectiveNamespace()
default @NonNull Immutable	effectivePath()	Return the effective path of this statement.
default @NonNull SchemaPath	getSchemaPath()	Return the SchemaNode.getPath() of this statement, failing if it is not present.
default @Nullable SchemaPath	optionalPath()	Return an optional-to-provide path for SchemaNode.getPath().
@Nullable SchemaPath	schemaPath()	Return the SchemaNode.getPath() of this statement.

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

getRawArgument, origin, producesDeclared, producesEffective, publicDefinition, rawArgument, sourceReference

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

effectiveParent, getEffectiveParent

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

history

Method Detail

effectiveConfig

@NonNull EffectiveStmtCtx.Parent.EffectiveConfig effectiveConfig()

Return the effective config statement value.

Returns:

This statement's effective config

effectiveNamespace

@NonNull QNameModule effectiveNamespace()

effectivePath

default @NonNull Immutable effectivePath()

Return the effective path of this statement. This method is intended for use with statements which naturally have a QName identifier and this identifier forms the ultimate step in their SchemaNode.getPath().

Returned object conforms to SchemaPathSupport's view of how these are to be handled. Users of this method are expected to consult SchemaNodeDefaults.extractQName(Immutable) and SchemaNodeDefaults.extractPath(Object, Immutable) to ensure correct implementation behaviour with respect to SchemaNode.getQName() and SchemaNode.getPath() respectively.

Returns:

An Immutable effective path object

optionalPath

default @Nullable SchemaPath optionalPath()

Return an optional-to-provide path for SchemaNode.getPath(). The result of this method is expected to be consulted with SchemaNodeDefaults.throwUnsupportedIfNull(Object, SchemaPath) to get consistent API behaviour.

Returns:

Potentially-null SchemaPath.

schemaPath

@Nullable SchemaPath schemaPath()

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

Returns:

SchemaPath or null

getSchemaPath

default @NonNull SchemaPath getSchemaPath()

Return the SchemaNode.getPath() of this statement, failing if it is not present.

Returns:

A SchemaPath.

Throws:

VerifyException - if schemaPath() returns null