StatementSupport (yangtools 3.0.0-SNAPSHOT API)

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:

AbstractQNameStatementSupport, AbstractStatementSupport, ActionStatementSupport, AnnotationStatementSupport, AnydataStatementSupport, AnyxmlSchemaLocationStatementSupport, AnyxmlStatementSupport, AnyxmlStatementSupportOverride, ArgumentStatementSupport, AugmentStatementRFC6020Support, AugmentStatementRFC7950Support, BaseStatementSupport, BelongsToStatementSupport, BitStatementRFC6020Support, BitStatementRFC7950Support, CaseStatementRFC6020Support, CaseStatementRFC7950Support, ChoiceStatementRFC6020Support, ChoiceStatementRFC7950Support, ConfigStatementSupport, ContactStatementSupport, ContainerStatementRFC6020Support, ContainerStatementRFC7950Support, DefaultDenyAllStatementSupport, DefaultDenyWriteStatementSupport, DefaultStatementSupport, DescriptionStatementSupport, DeviateStatementRFC6020Support, DeviateStatementRFC7950Support, DeviationStatementSupport, EncryptedValueStatementSupport, EnumStatementRFC6020Support, EnumStatementRFC7950Support, ErrorAppTagStatementSupport, ErrorMessageStatementSupport, ExtensionStatementSupport, FeatureStatementSupport, ForwardingStatementSupport, FractionDigitsStatementSupport, GroupingStatementRFC6020Support, GroupingStatementRFC7950Support, HashedValueStatementSupport, IdentityStatementRFC6020Support, IdentityStatementRFC7950Support, IfFeatureStatementSupport, ImportStatementRFC6020Support, ImportStatementRFC7950Support, IncludeStatementRFC6020Support, IncludeStatementRFC7950Support, InputStatementRFC6020Support, InputStatementRFC7950Support, KeyStatementSupport, LeafListStatementRFC6020Support, LeafListStatementRFC7950Support, LeafStatementSupport, LengthStatementSupport, ListStatementRFC6020Support, ListStatementRFC7950Support, MandatoryStatementSupport, MaxElementsStatementSupport, MinElementsStatementSupport, ModifierStatementSupport, ModuleStatementRFC6020Support, ModuleStatementRFC7950Support, MustStatementSupport, NamespaceStatementSupport, NotificationStatementRFC6020Support, NotificationStatementRFC7950Support, OpenConfigVersionSupport, OrderedByStatementSupport, OrganizationStatementSupport, OutputStatementRFC6020Support, OutputStatementRFC7950Support, PathStatementSupport, PatternStatementRFC6020Support, PatternStatementRFC7950Support, PositionStatementSupport, PrefixStatementSupport, PresenceStatementSupport, RangeStatementSupport, ReferenceStatementSupport, RefineStatementRFC6020Support, RefineStatementRFC7950Support, RequireInstanceStatementSupport, RevisionDateStatementSupport, RevisionStatementSupport, RpcStatementRFC6020Support, RpcStatementRFC7950Support, StatusStatementSupport, SubmoduleStatementRFC6020Support, SubmoduleStatementRFC7950Support, TypedefStatementSupport, TypeStatementRFC6020Support, TypeStatementRFC7950Support, UniqueStatementSupport, UnitsStatementSupport, UsesStatementSupport, ValueStatementSupport, WhenStatementSupport, YangDataStatementSupport, YangVersionStatementSupport, YinElementStatementSupport
```
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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default A`	`adaptArgumentValue(StmtContext<A,D,E> ctx, QNameModule targetModule)` Adapts the argument value to match a new module.
`default QName`	`getArgumentName()` Returns name of statement argument or null, if statement does not have argument.
`default Class<? extends DeclaredStatement<?>>`	`getDeclaredRepresentationClass()` Returns class which represents declared version of statement associated with this definition.
`default Class<? extends EffectiveStatement<?,?>>`	`getEffectiveRepresentationClass()` Returns class which represents derived behaviour from supplied statement.
`@NonNull StatementDefinition`	`getPublicView()` Returns public statement definition, which will be present in built statements.
`default QName`	`getStatementName()` Returns name of the statement.
`@Nullable StatementSupport<?,?,?>`	`getSupportSpecificForArgument(String argument)` If this support has argument specific supports, the method returns support specific for given argument (e.g.
`default Optional<StatementSupport<?,?,?>>`	`getUnknownStatementDefinitionOf(StatementDefinition yangStmtDef)` Returns unknown statement form of a regular YANG statement supplied as a 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`	`isArgumentYinElement()` Returns true, if argument of statement is represented as value of yin element.
`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, 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.
`A`	`parseArgumentValue(StmtContext<?,?,?> ctx, String value)` Parses textual representation of argument in object representation.

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

- Method Detail
  - getPublicView
```
@NonNull 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.
  - adaptArgumentValue
```
default A adaptArgumentValue(StmtContext<A,D,E> ctx,
                             QNameModule targetModule)
```
    Adapts the argument value to match a new module.
    
    Parameters:
    
    ctx - Context, which may be used to access source-specific namespaces required for parsing.
    
    targetModule - Target module, may not be null.
    
    Returns:
    
    Adapted argument value. The default implementation returns original value stored in context.
  - 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.
  - 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, 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<StatementSupport<?,?,?>> getUnknownStatementDefinitionOf(StatementDefinition yangStmtDef)
```
    Returns unknown statement form of a regular YANG statement supplied as a 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 RFC 8040). 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 RFC 8040). Default implementation returns false.
    
    Returns:
    
    true if this statement support ignores config statements, otherwise false.
  - getStatementName
```
default QName getStatementName()
```
    Description copied from interface: StatementDefinition
    
    Returns name of the statement.
    
    Specified by:
    
    getStatementName in interface StatementDefinition
    
    Returns:
    
    Name of the statement
  - getArgumentName
```
default 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
```
default 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 an 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
```
default Class<? extends EffectiveStatement<?,?>> getEffectiveRepresentationClass()
```
    Description copied from interface: StatementDefinition
    
    Returns class which represents derived behaviour from supplied statement. This class should be an 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
  - isArgumentYinElement
```
default 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. If this statement does not have an argument, this method returns false.
    
    Specified by:
    
    isArgumentYinElement in interface StatementDefinition
    
    Returns:
    
    returns true, if statement argument is represented as value of yin element, otherwise returns false.

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

Method Summary

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

Method Detail

getPublicView

parseArgumentValue

adaptArgumentValue

onStatementAdded

onPreLinkageDeclared

onLinkageDeclared

onStatementDefinitionDeclared

onFullDefinitionDeclared

hasArgumentSpecificSupports

getSupportSpecificForArgument

internArgument

getUnknownStatementDefinitionOf

isIgnoringIfFeatures

isIgnoringConfig

getStatementName

getArgumentName

getDeclaredRepresentationClass

getEffectiveRepresentationClass

isArgumentYinElement