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

Class ForwardingStatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

java.lang.Object

com.google.common.collect.ForwardingObject

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

Type Parameters:

A - Argument type

D - Declared Statement representation

E - Effective Statement representation

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Immutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Immutable>, org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition, StatementFactory<A,D,E>, StatementSupport<A,D,E>

@Beta
public abstract class ForwardingStatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>
extends com.google.common.collect.ForwardingObject
implements StatementSupport<A,D,E>

Utility forwarding implementation of StatementSupport contract. This class is useful for implementing wrapped statements.

Author:

Robert Varga

Constructor Summary

Constructors

Constructor and Description
ForwardingStatementSupport()

Method Summary

Modifier and Type	Method and Description
D	createDeclared(StmtContext<A,D,?> ctx) Create a DeclaredStatement for specified context.
E	createEffective(StmtContext<A,D,E> ctx) Create a EffectiveStatement for specified context.
protected abstract StatementSupport<A,D,E>	delegate()
org.opendaylight.yangtools.yang.model.api.meta.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.
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.
A	parseArgumentValue(StmtContext<?,?,?> ctx, String value) Parses textual representation of argument in object representation.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

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

adaptArgumentValue, getArgumentDefinition, getDeclaredRepresentationClass, getEffectiveRepresentationClass, getStatementName, getUnknownStatementDefinitionOf, internArgument, isIgnoringConfig, isIgnoringIfFeatures

Constructor Detail

ForwardingStatementSupport

public ForwardingStatementSupport()

Method Detail

delegate

protected abstract StatementSupport<A,D,E> delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingObject

createDeclared

public D createDeclared(StmtContext<A,D,?> ctx)

Description copied from interface: StatementFactory

Create a DeclaredStatement for specified context.

Specified by:

createDeclared in interface StatementFactory<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Parameters:

ctx - Statement context

Returns:

A declared statement instance.

createEffective

public E createEffective(StmtContext<A,D,E> ctx)

Description copied from interface: StatementFactory

Create a EffectiveStatement for specified context.

Specified by:

createEffective in interface StatementFactory<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Parameters:

ctx - Statement context

Returns:

An effective statement instance.

getPublicView

public org.opendaylight.yangtools.yang.model.api.meta.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 org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Returns:

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

parseArgumentValue

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

Description copied from interface: StatementSupport

Parses textual representation of argument in object representation.

Specified by:

parseArgumentValue in interface StatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,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

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 org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Parameters:

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

onPreLinkageDeclared

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

Description copied from interface: StatementSupport

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

Specified by:

onPreLinkageDeclared in interface StatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Parameters:

stmt - Context of added statement.

onLinkageDeclared

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

Description copied from interface: StatementSupport

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

Specified by:

onLinkageDeclared in interface StatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Parameters:

stmt - Context of added statement.

onStatementDefinitionDeclared

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

Description copied from interface: StatementSupport

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

Specified by:

onStatementDefinitionDeclared in interface StatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.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)

Description copied from interface: StatementSupport

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

Specified by:

onFullDefinitionDeclared in interface StatementSupport<A,D extends org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.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 org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.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 org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement<A>,E extends org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement<A,D>>

Parameters:

argument - argument of statement

Returns:

statement support specific for supplied argument or null