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

Class AbstractStatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

java.lang.Object

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

Type Parameters:

A - Argument type

D - Declared Statement representation

E - Effective Statement representation

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractQNameStatementSupport, AnnotationStatementSupport, AnyxmlSchemaLocationStatementSupport, AugmentStatementRFC6020Support, AugmentStatementRFC7950Support, BelongsToStatementSupport, ConfigStatementSupport, ContactStatementSupport, DefaultDenyAllStatementSupport, DefaultDenyWriteStatementSupport, DefaultStatementSupport, DescriptionStatementSupport, DeviateStatementRFC6020Support, DeviateStatementRFC7950Support, DeviationStatementSupport, EncryptedValueStatementSupport, EnumStatementRFC6020Support, EnumStatementRFC7950Support, ErrorAppTagStatementSupport, ErrorMessageStatementSupport, FractionDigitsStatementSupport, HashedValueStatementSupport, IfFeatureStatementSupport, ImportStatementRFC6020Support, ImportStatementRFC7950Support, IncludeStatementRFC6020Support, IncludeStatementRFC7950Support, KeyStatementSupport, LengthStatementSupport, MandatoryStatementSupport, MaxElementsStatementSupport, MinElementsStatementSupport, ModifierStatementSupport, ModuleStatementRFC6020Support, ModuleStatementRFC7950Support, MustStatementSupport, NamespaceStatementSupport, OpenConfigVersionSupport, OrderedByStatementSupport, OrganizationStatementSupport, PathStatementSupport, PatternStatementRFC6020Support, PatternStatementRFC7950Support, PositionStatementSupport, PrefixStatementSupport, PresenceStatementSupport, RangeStatementSupport, ReferenceStatementSupport, RefineStatementRFC6020Support, RefineStatementRFC7950Support, RequireInstanceStatementSupport, RevisionDateStatementSupport, RevisionStatementSupport, StatusStatementSupport, SubmoduleStatementRFC6020Support, SubmoduleStatementRFC7950Support, TypeStatementRFC6020Support, TypeStatementRFC7950Support, UniqueStatementSupport, UnitsStatementSupport, ValueStatementSupport, WhenStatementSupport, YangDataStatementSupport, YangVersionStatementSupport, YinElementStatementSupport

public abstract class AbstractStatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>
extends Object
implements StatementDefinition, StatementFactory<A,D,E>, StatementSupport<A,D,E>

Class providing necessary support for processing a YANG statement. This class is intended to be subclassed by developers who want to add semantic support for a statement to a parser reactor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStatementSupport(StatementDefinition publicDefinition)

Method Summary

Modifier and Type	Method and Description
StatementDefinition	getPublicView() Returns public statement definition, which will be present in built statements.
protected abstract @Nullable SubstatementValidator	getSubstatementValidator() Returns corresponding substatement validator of a statement support.
StatementSupport<?,?,?>	getSupportSpecificForArgument(String argument) If this support has argument specific supports, the method returns support specific for given argument (e.g.
boolean	hasArgumentSpecificSupports() Returns true if this support has argument specific supports.
void	onFullDefinitionDeclared(StmtContext.Mutable<A,D,E> stmt) Invoked when statement is closed during ModelProcessingPhase.FULL_DECLARATION phase, only substatements from this phase are available.
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.

Methods inherited from class java.lang.Object

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

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

adaptArgumentValue, getArgumentName, getDeclaredRepresentationClass, getEffectiveRepresentationClass, getStatementName, getUnknownStatementDefinitionOf, internArgument, isArgumentYinElement, isIgnoringConfig, isIgnoringIfFeatures, parseArgumentValue

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

createDeclared, createEffective

Constructor Detail

AbstractStatementSupport

protected AbstractStatementSupport(StatementDefinition publicDefinition)

Method Detail

getPublicView

public final StatementDefinition getPublicView()

Description copied from interface: StatementSupport

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.

Specified by:

getPublicView in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Returns:

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

onStatementAdded

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

Description copied from interface: StatementSupport

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.

Specified by:

onStatementAdded in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Parameters:

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

onPreLinkageDeclared

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

Subclasses of this class may override this method to perform actions on this event or register a modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Specified by:

onPreLinkageDeclared in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Parameters:

stmt - Context of added statement.

onLinkageDeclared

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

Subclasses of this class may override this method to perform actions on this event or register a modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Specified by:

onLinkageDeclared in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Parameters:

stmt - Context of added statement.

onStatementDefinitionDeclared

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

Subclasses of this class may override this method to perform actions on this event or register a modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Specified by:

onStatementDefinitionDeclared in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Parameters:

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

onFullDefinitionDeclared

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

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

Subclasses of this class may override this method to perform actions on this event or register a modification action using StmtContext.Mutable.newInferenceAction(ModelProcessingPhase).

Specified by:

onFullDefinitionDeclared in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Parameters:

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

hasArgumentSpecificSupports

public boolean hasArgumentSpecificSupports()

Description copied from interface: StatementSupport

Returns true if this support has argument specific supports.

Specified by:

hasArgumentSpecificSupports in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

getSupportSpecificForArgument

public StatementSupport<?,?,?> getSupportSpecificForArgument(String argument)

Description copied from interface: StatementSupport

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.

Specified by:

getSupportSpecificForArgument in interface StatementSupport<A,D extends DeclaredStatement<A>,E extends EffectiveStatement<A,D>>

Parameters:

argument - argument of statement

Returns:

statement support specific for supplied argument or null

getSubstatementValidator

protected abstract @Nullable SubstatementValidator getSubstatementValidator()

Returns corresponding substatement validator of a statement support.

Returns:

substatement validator or null, if substatement validator is not defined