Module org.opendaylight.yangtools.yang.parser.spi

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

Class AbstractSchemaTreeStatementSupport<D extends DeclaredStatement<QName>,E extends SchemaTreeEffectiveStatement<D>>

java.lang.Object

org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport<A,D,E>

org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport<QName,D,E>

org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport<D,E>

org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport<D,E>

Type Parameters:

D - Declared Statement representation

E - Effective Statement representation

All Implemented Interfaces:

StatementFactory<QName,D,E>

@Beta
public abstract class AbstractSchemaTreeStatementSupport<D extends DeclaredStatement<QName>,E extends SchemaTreeEffectiveStatement<D>>
extends AbstractQNameStatementSupport<D,E>

Specialization of AbstractQNameStatementSupport for SchemaTreeEffectiveStatement implementations. Every statement automatically participates in ParserNamespaces.schemaTree().

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport

StatementSupport.CopyPolicy, StatementSupport.StatementEquality<A,D extends DeclaredStatement<A>>, StatementSupport.StatementPolicy<A,D extends DeclaredStatement<A>>

Field Summary

Fields inherited from class org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport

NAMESPACE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSchemaTreeStatementSupport(StatementDefinition publicDefinition, StatementSupport.StatementPolicy<QName,D> policy, org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration config, @Nullable SubstatementValidator validator)

Method Summary

Modifier and Type	Method	Description
static final <D extends DeclaredStatement<QName>> StatementSupport.StatementPolicy<QName,D>	instantiatedPolicy()	Return the StatementSupport.StatementPolicy corresponding to a potentially-instantiated YANG statement.
void	onStatementAdded(StmtContext.Mutable<QName,D,E> stmt)	Invoked when a statement supported by this instance is added to build context.
QName	parseArgumentValue(StmtContext<?,?,?> ctx, String value)	Parses textual representation of argument in object representation.
static final <D extends DeclaredStatement<QName>> StatementSupport.StatementPolicy<QName,D>	uninstantiatedPolicy()	Return the StatementSupport.StatementPolicy corresponding to an uninstantiated YANG statement.

Methods inherited from class org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport

adaptArgumentValue

Methods inherited from class org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport

attachDeclarationReference, buildEffectiveSubstatements, copyEffective, createDeclared, createDeclared, createEffective, createEffective, findFirstArgument, findFirstStatement, statementsToBuild, substatementValidator

Methods inherited from class org.opendaylight.yangtools.yang.parser.spi.meta.StatementSupport

argumentName, canReuseCurrent, copyPolicy, definition, extractEffectiveState, getArgumentDefinition, getPublicView, getSupportSpecificForArgument, hasArgumentSpecificSupports, internArgument, isIgnoringConfig, isIgnoringIfFeatures, onFullDefinitionDeclared, onLinkageDeclared, onPreLinkageDeclared, onStatementDefinitionDeclared, statementName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractSchemaTreeStatementSupport

protected AbstractSchemaTreeStatementSupport(StatementDefinition publicDefinition,
 StatementSupport.StatementPolicy<QName,D> policy,
 org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration config,
 @Nullable SubstatementValidator validator)

Method Details

instantiatedPolicy

public static final <D extends DeclaredStatement<QName>>
StatementSupport.StatementPolicy<QName,D> instantiatedPolicy()

Return the StatementSupport.StatementPolicy corresponding to a potentially-instantiated YANG statement. Statements are reused as long as:

• BoundStmtCtx.argument() does not change
• StmtContextCompat.history() does not change as far as CopyableNode is concerned
• EffectiveStmtCtx.Parent.effectiveConfig() does not change

Typical users include container and leaf.

Type Parameters:

D - Declared Statement representation

Returns:

A StatementPolicy

uninstantiatedPolicy

public static final <D extends DeclaredStatement<QName>>
StatementSupport.StatementPolicy<QName,D> uninstantiatedPolicy()

Return the StatementSupport.StatementPolicy corresponding to an uninstantiated YANG statement. Statements are reused as long as:

• BoundStmtCtx.argument() does not change
• StmtContextCompat.history() does not change as far as CopyableNode is concerned

Typical users include action and notification (in its YANG 1.1 form).

Type Parameters:

D - Declared Statement representation

Returns:

A StatementPolicy

onStatementAdded

public void onStatementAdded(StmtContext.Mutable<QName,D,E> stmt)

Invoked when a statement supported by this instance is added to build context. This allows implementations of this interface to start tracking the statement and perform any modifications to the build context hierarchy, accessible via StmtContext.getParentContext(). One such use is populating the parent's namespaces to allow it to locate this child statement.

This method ensures the statement is added to its parent ParserNamespaces.schemaTree().

Overrides:

onStatementAdded in class StatementSupport<QName,D extends DeclaredStatement<QName>,E extends SchemaTreeEffectiveStatement<D>>

Parameters:

stmt - Context of added statement. No substatements are available.

parseArgumentValue

public QName parseArgumentValue(StmtContext<?,?,?> ctx,
 String value)

Description copied from class: StatementSupport

Parses textual representation of argument in object representation.

Specified by:

parseArgumentValue in class StatementSupport<QName,D extends DeclaredStatement<QName>,E extends SchemaTreeEffectiveStatement<D>>

Parameters:

ctx - Context, which may be used to access source-specific namespaces required for parsing.

value - String representation of value, as was present in text source.

Returns:

Parsed value