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:

ActionStatementImpl.Definition, AnydataStatementImpl.Definition, AnyxmlSchemaLocationStatementImpl.AnyxmlSchemaLocationSupport, AnyxmlStatementImpl.Definition, ArgumentStatementImpl.Definition, AugmentStatementImpl.Definition, BaseStatementImpl.Definition, BelongsToStatementImpl.Definition, BitsSpecificationImpl.Definition, BitStatementImpl.Definition, CaseStatementImpl.Definition, ChoiceStatementImpl.Definition, ConfigStatementImpl.Definition, ContactStatementImpl.Definition, ContainerStatementImpl.Definition, Decimal64SpecificationImpl.Definition, DefaultStatementImpl.Definition, DescriptionStatementImpl.Definition, DeviateStatementImpl.Definition, DeviationStatementImpl.Definition, EnumSpecificationImpl.Definition, EnumStatementImpl.Definition, ErrorAppTagStatementImpl.Definition, ErrorMessageStatementImpl.Definition, ExtensionStatementImpl.Definition, FeatureStatementImpl.Definition, FractionDigitsStatementImpl.Definition, GroupingStatementImpl.Definition, IdentityRefSpecificationImpl.Definition, IdentityStatementImpl.Definition, IfFeatureStatementImpl.Definition, ImportStatementDefinition, IncludeStatementImpl.Definition, InputStatementImpl.Definition, InstanceIdentifierSpecificationImpl.Definition, KeyStatementImpl.Definition, LeafListStatementImpl.Definition, LeafrefSpecificationImpl.Definition, LeafStatementImpl.Definition, LengthStatementImpl.Definition, ListStatementImpl.Definition, MandatoryStatementImpl.Definition, MaxElementsStatementImpl.Definition, MinElementsStatementImpl.Definition, ModelDefinedStatementSupport, ModifierStatementImpl.Definition, ModuleStatementSupport, MustStatementImpl.Definition, NamespaceStatementImpl.Definition, NotificationStatementImpl.Definition, NumericalRestrictionsImpl.Definition, OpenconfigVersionStatementImpl.OpenconfigVersionSupport, OrderedByStatementImpl.Definition, OrganizationStatementImpl.Definition, OutputStatementImpl.Definition, PathStatementImpl.Definition, PatternStatementImpl.Definition, PositionStatementImpl.Definition, PrefixStatementImpl.Definition, PresenceStatementImpl.Definition, RangeStatementImpl.Definition, ReferenceStatementImpl.Definition, RefineStatementImpl.Definition, RequireInstanceStatementImpl.Definition, RevisionDateStatementImpl.Definition, RevisionStatementImpl.Definition, RpcStatementImpl.Definition, StatusStatementImpl.Definition, StringRestrictionsImpl.Definition, SubmoduleStatementImpl.Definition, TypedefStatementImpl.Definition, TypeStatementImpl.Definition, UnionSpecificationImpl.Definition, UniqueStatementImpl.Definition, UnitsStatementImpl.Definition, UnknownStatementImpl.Definition, UsesStatementImpl.Definition, ValueStatementImpl.Definition, WhenStatementImpl.Definition, YangDataStatementImpl.YangDataSupport, YangVersionStatementImpl.Definition, YinElementStatementImpl.Definition

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 YANG statement. This class is intended to be subclassed by developers, which want to introduce support of statement to parser.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStatementSupport(StatementDefinition publicDefinition)

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.
QName	getArgumentName() Returns name of statement argument or null, if statement does not have argument.
Class<? extends DeclaredStatement<?>>	getDeclaredRepresentationClass() Returns class which represents declared version of statement associated with this definition.
Class<? extends EffectiveStatement<?,?>>	getEffectiveRepresentationClass() Returns class which represents derived behaviour from supplied statement.
StatementDefinition	getPublicView() Returns public statement definition, which will be present in built statements.
QName	getStatementName() Returns name of the statement
protected abstract 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.
boolean	isArgumentYinElement() Returns true, if argument of statement is represented as value of yin element.
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.

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

getUnknownStatementDefinitionOf, internArgument, 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

getStatementName

@Nonnull
public final QName getStatementName()

Description copied from interface: StatementDefinition

Returns name of the statement

Specified by:

getStatementName in interface StatementDefinition

Returns:

Name of the statement

getArgumentName

public final QName getArgumentName()

Description copied from interface: StatementDefinition

Returns name of statement argument or null, if statement does not have argument.

Specified by:

getArgumentName in interface StatementDefinition

Returns:

argument name or null, if statement does not take argument.

getDeclaredRepresentationClass

@Nonnull
public final Class<? extends DeclaredStatement<?>> getDeclaredRepresentationClass()

Description copied from interface: StatementDefinition

Returns class which represents declared version of statement associated with this definition. This class should be interface, which provides convenience access to declared substatements.

Specified by:

getDeclaredRepresentationClass in interface StatementDefinition

Returns:

class which represents declared version of statement associated with this definition.

getEffectiveRepresentationClass

@Nonnull
public final Class<? extends EffectiveStatement<?,?>> getEffectiveRepresentationClass()

Description copied from interface: StatementDefinition

Returns class which represents derived behaviour from supplied statement. This class should be interface, which defines convenience access to statement properties, namespace items and substatements.

Specified by:

getEffectiveRepresentationClass in interface StatementDefinition

Returns:

class which represents effective version of statement associated with this definition

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.

beforeSubStatementCreated

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

Description copied from interface: StatementSupport

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.

Specified by:

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

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

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

isArgumentYinElement

public boolean isArgumentYinElement()

Description copied from interface: StatementDefinition

Returns true, if argument of statement is represented as value of yin element. If argument of statement is represented as argument of yin element, returns false.

Specified by:

isArgumentYinElement in interface StatementDefinition

Returns:

returns true, if statement argument is represented as value of yin element, otherwise returns false.

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

@Nullable
protected abstract SubstatementValidator getSubstatementValidator()

Returns corresponding substatement validator of a statement support

Returns:

substatement validator or null, if substatement validator is not defined