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

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

Type Parameters:

A - Argument type

D - Declared Statement representation

E - Effective Statement representation

All Superinterfaces:

Immutable, MutationBehaviour<Immutable>, StatementDefinition, StatementFactory<A,D,E>

All Known Implementing Classes:

AbstractStatementSupport, ActionStatementImpl.Definition, AnydataStatementImpl.Definition, AnyxmlSchemaLocationStatementImpl.AnyxmlSchemaLocationSupport, AnyxmlStatementImpl.Definition, ArgumentStatementImpl.Definition, AugmentStatementImpl.Definition, AugmentStatementRfc7950Support, BaseStatementImpl.Definition, BelongsToStatementImpl.Definition, BitsSpecificationImpl.Definition, BitStatementImpl.Definition, BitStatementRfc7950Support, CaseStatementImpl.Definition, CaseStatementRfc7950Support, ChoiceStatementImpl.Definition, ChoiceStatementRfc7950Support, ConfigStatementImpl.Definition, ContactStatementImpl.Definition, ContainerStatementImpl.Definition, ContainerStatementRfc7950Support, Decimal64SpecificationImpl.Definition, DefaultStatementImpl.Definition, DescriptionStatementImpl.Definition, DeviateStatementImpl.Definition, DeviateStatementRfc7950Support, DeviationStatementImpl.Definition, EnumSpecificationImpl.Definition, EnumStatementImpl.Definition, EnumStatementRfc7950Support, ErrorAppTagStatementImpl.Definition, ErrorMessageStatementImpl.Definition, ExtensionStatementImpl.Definition, FeatureStatementImpl.Definition, FractionDigitsStatementImpl.Definition, GroupingStatementImpl.Definition, GroupingStatementRfc7950Support, IdentityRefSpecificationImpl.Definition, IdentityrefSpecificationRfc7950Support, IdentityStatementImpl.Definition, IdentityStatementRfc7950Support, IfFeatureStatementImpl.Definition, ImportStatementDefinition, ImportStatementRfc7950Support, IncludeStatementImpl.Definition, IncludeStatementRfc7950Support, InputStatementImpl.Definition, InputStatementRfc7950Support, InstanceIdentifierSpecificationImpl.Definition, KeyStatementImpl.Definition, LeafListStatementImpl.Definition, LeafListStatementRfc7950Support, LeafrefSpecificationImpl.Definition, LeafrefSpecificationRfc7950Support, LeafStatementImpl.Definition, LengthStatementImpl.Definition, ListStatementImpl.Definition, ListStatementRfc7950Support, MandatoryStatementImpl.Definition, MaxElementsStatementImpl.Definition, MinElementsStatementImpl.Definition, ModelDefinedStatementSupport, ModifierStatementImpl.Definition, ModuleStatementRfc7950Support, ModuleStatementSupport, MustStatementImpl.Definition, NamespaceStatementImpl.Definition, NotificationStatementImpl.Definition, NotificationStatementRfc7950Support, NumericalRestrictionsImpl.Definition, OpenconfigVersionStatementImpl.OpenconfigVersionSupport, OrderedByStatementImpl.Definition, OrganizationStatementImpl.Definition, OutputStatementImpl.Definition, OutputStatementRfc7950Support, PathStatementImpl.Definition, PatternStatementImpl.Definition, PatternStatementRfc7950Support, PositionStatementImpl.Definition, PrefixStatementImpl.Definition, PresenceStatementImpl.Definition, RangeStatementImpl.Definition, ReferenceStatementImpl.Definition, RefineStatementImpl.Definition, RefineStatementRfc7950Support, RequireInstanceStatementImpl.Definition, RevisionDateStatementImpl.Definition, RevisionStatementImpl.Definition, RpcStatementImpl.Definition, RpcStatementRfc7950Support, StatusStatementImpl.Definition, StringRestrictionsImpl.Definition, SubmoduleStatementImpl.Definition, SubmoduleStatementRfc7950Support, TypedefStatementImpl.Definition, TypeStatementImpl.Definition, TypeStatementRfc7950Support, UnionSpecificationImpl.Definition, UniqueStatementImpl.Definition, UnitsStatementImpl.Definition, UnknownStatementImpl.Definition, UsesStatementImpl.Definition, ValueStatementImpl.Definition, WhenStatementImpl.Definition, YangDataStatementImpl.YangDataSupport, YangVersionStatementImpl.Definition, YinElementStatementImpl.Definition

public interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>
extends StatementDefinition, StatementFactory<A,D,E>

Support for processing concrete YANG statement.

This interface is intended to be implemented by developers, which want to introduce support of statement to parser. Consider subclassing AbstractStatementSupport for easier implementation of this interface.

Method Summary

Modifier and Type	Method and Description
Optional<StatementContextBase<?,?,?>>	beforeSubStatementCreated(StmtContext.Mutable<?,?,?> stmt, int offset, StatementDefinitionContext<?,?,?> def, StatementSourceReference ref, String argument) Invoked before a substatement with specified offset, definition, reference and argument is created and added to parent statement.
StatementDefinition	getPublicView() Returns public statement definition, which will be present in built statements.
StatementSupport<?,?,?>	getSupportSpecificForArgument(String argument) If this support has argument specific supports, the method returns support specific for given argument (e.g.
default Optional<StatementDefinitionContext<?,?,?>>	getUnknownStatementDefinitionOf(StatementDefinitionContext<?,?,?> yangStmtDef) Returns unknown statement form of a regular yang statement supplied as parameter to the method.
boolean	hasArgumentSpecificSupports() Returns true if this support has argument specific supports.
default String	internArgument(String rawArgument) Given a raw string representation of an argument, try to use a shared representation
default boolean	isIgnoringConfig() Returns true if this statement support and all its substatements ignore config statements (e.g.
default boolean	isIgnoringIfFeatures() Returns true if this statement support and all its substatements ignore if-feature statements (e.g.
void	onFullDefinitionDeclared(StmtContext.Mutable<A,D,E> stmt) Invoked when statement is closed during ModelProcessingPhase.FULL_DECLARATION phase.
void	onLinkageDeclared(StmtContext.Mutable<A,D,E> stmt) Invoked when statement is closed during ModelProcessingPhase.SOURCE_LINKAGE phase, only substatements from this and previous phase are available.
void	onPreLinkageDeclared(StmtContext.Mutable<A,D,E> stmt) Invoked when statement is closed during ModelProcessingPhase.SOURCE_PRE_LINKAGE phase, only substatements from this and previous phase are available.
void	onStatementAdded(StmtContext.Mutable<A,D,E> stmt) Invoked when a statement supported by this instance is added to build context.
void	onStatementDefinitionDeclared(StmtContext.Mutable<A,D,E> stmt) Invoked when statement is closed during ModelProcessingPhase.STATEMENT_DEFINITION phase, only substatements from this phase are available.
A	parseArgumentValue(StmtContext<?,?,?> ctx, String value) Parses textual representation of argument in object representation.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition

getArgumentName, getDeclaredRepresentationClass, getEffectiveRepresentationClass, getStatementName, isArgumentYinElement

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

createDeclared, createEffective

Method Detail

getPublicView

StatementDefinition getPublicView()

Returns public statement definition, which will be present in built statements. Public statement definition may be used to provide different implementation of statement definition, which will not retain any build specific data or context.

Returns:

public statement definition, which will be present in built statements.

parseArgumentValue

A parseArgumentValue(StmtContext<?,?,?> ctx,
                     String value)

Parses textual representation of argument in object representation.

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

Throws:

SourceException - when an inconsistency is detected.

onStatementAdded

void onStatementAdded(StmtContext.Mutable<A,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.

Parameters:

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

beforeSubStatementCreated

Optional<StatementContextBase<?,?,?>> beforeSubStatementCreated(StmtContext.Mutable<?,?,?> stmt,
                                                                int offset,
                                                                StatementDefinitionContext<?,?,?> def,
                                                                StatementSourceReference ref,
                                                                String argument)

Invoked before a substatement with specified offset, definition, reference and argument is created and added to parent statement. This allows implementations of this interface perform any modifications to the build context hierarchy before a substatement is created. One such use is creating an implicit statement.

Parameters:

stmt - Context of parent statement where a new substatement should be created. No substatements are available.

offset - substatement offset

def - definition context

ref - source reference

argument - substatement argument

Returns:

optional of an implicit substatement

onPreLinkageDeclared

void onPreLinkageDeclared(StmtContext.Mutable<A,D,E> stmt)

Invoked when statement is closed during ModelProcessingPhase.SOURCE_PRE_LINKAGE phase, only substatements from this and previous phase are available. Implementation may use method to perform actions on this event or register modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Parameters:

stmt - Context of added statement.

onLinkageDeclared

void onLinkageDeclared(StmtContext.Mutable<A,D,E> stmt)

Invoked when statement is closed during ModelProcessingPhase.SOURCE_LINKAGE phase, only substatements from this and previous phase are available. Implementation may use method to perform actions on this event or register modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Parameters:

stmt - Context of added statement.

Throws:

SourceException - when an inconsistency is detected.

onStatementDefinitionDeclared

void onStatementDefinitionDeclared(StmtContext.Mutable<A,D,E> stmt)

Invoked when statement is closed during ModelProcessingPhase.STATEMENT_DEFINITION phase, only substatements from this phase are available. Implementation may use method to perform actions on this event or register modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Parameters:

stmt - Context of added statement. Argument and statement parent is accessible.

Throws:

SourceException - when an inconsistency is detected.

onFullDefinitionDeclared

void onFullDefinitionDeclared(StmtContext.Mutable<A,D,E> stmt)

Invoked when statement is closed during ModelProcessingPhase.FULL_DECLARATION phase. Invoked when statement is closed during ModelProcessingPhase.FULL_DECLARATION phase, only substatements from this phase are available. Implementation may use method to perform actions on this event or register modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Parameters:

stmt - Context of added statement. Argument and statement parent is accessible.

Throws:

SourceException - when an inconsistency is detected.

hasArgumentSpecificSupports

boolean hasArgumentSpecificSupports()

Returns true if this support has argument specific supports.

getSupportSpecificForArgument

@Nullable
StatementSupport<?,?,?> getSupportSpecificForArgument(String argument)

If this support has argument specific supports, the method returns support specific for given argument (e.g. type statement support need to be specialized based on its argument), otherwise returns null.

Parameters:

argument - argument of statement

Returns:

statement support specific for supplied argument or null

internArgument

default String internArgument(String rawArgument)

Given a raw string representation of an argument, try to use a shared representation

Parameters:

rawArgument - Argument string

Returns:

A potentially-shard instance

getUnknownStatementDefinitionOf

default Optional<StatementDefinitionContext<?,?,?>> getUnknownStatementDefinitionOf(StatementDefinitionContext<?,?,?> yangStmtDef)

Returns unknown statement form of a regular yang statement supplied as parameter to the method.

Parameters:

yangStmtDef - statement definition of a regular yang statement

Returns:

Optional of unknown statement form of a regular yang statement or Optional.empty() if it is not supported by this statement support

isIgnoringIfFeatures

@Beta
default boolean isIgnoringIfFeatures()

Returns true if this statement support and all its substatements ignore if-feature statements (e.g. yang-data extension defined in https://tools.ietf.org/html/rfc8040#section-8). Default implementation returns false.

Returns:

true if this statement support ignores if-feature statements, otherwise false.

isIgnoringConfig

@Beta
default boolean isIgnoringConfig()

Returns true if this statement support and all its substatements ignore config statements (e.g. yang-data extension defined in https://tools.ietf.org/html/rfc8040#section-8). Default implementation returns false.

Returns:

true if this statement support ignores config statements, otherwise false.