org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective

Class AugmentEffectiveStatementImpl

java.lang.Object

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.DeclaredEffectiveStatementBase<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AbstractEffectiveDocumentedNode<A,D>

org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AugmentEffectiveStatementImpl

All Implemented Interfaces:

ActionNodeContainer, AugmentationSchema, DataNodeContainer, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatement<SchemaNodeIdentifier,AugmentStatement>, ModelStatement<SchemaNodeIdentifier>, NamespaceRevisionAware, NotificationNodeContainer

public final class AugmentEffectiveStatementImpl
extends AbstractEffectiveDocumentedNode<A,D>
implements AugmentationSchema, NamespaceRevisionAware

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Constructor Summary

Constructors

Constructor and Description
AugmentEffectiveStatementImpl(StmtContext<SchemaNodeIdentifier,AugmentStatement,EffectiveStatement<SchemaNodeIdentifier,AugmentStatement>> ctx)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<ActionDefinition>	getActions() All implementations should override this method.
Set<DataSchemaNode>	getChildNodes() Returns set of all child nodes defined within this DataNodeContainer.
DataSchemaNode	getDataChildByName(QName name) Returns the child node corresponding to the specified name.
Set<GroupingDefinition>	getGroupings() Returns set of all groupings defined within this DataNodeContainer.
URI	getNamespace()
Set<NotificationDefinition>	getNotifications() All implementations should override this method.
com.google.common.base.Optional<AugmentationSchema>	getOriginalDefinition() Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.
Date	getRevision()
SchemaPath	getTargetPath() Returns augmentation schema path.
Set<TypeDefinition<?>>	getTypeDefinitions() Returns set of all newly defined types within this DataNodeContainer.
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown schema node children.
Set<UsesNode>	getUses() Returns grouping nodes used ny this container.
RevisionAwareXPath	getWhenCondition() Returns when statement.
int	hashCode()
String	toString()

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AbstractEffectiveDocumentedNode

getDescription, getReference, getStatus

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.DeclaredEffectiveStatementBase

argument, getDeclared, getStatementSource, statementDefinition

Methods inherited from class org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.EffectiveStatementBase

allSubstatementsOfType, effectiveSubstatements, firstEffective, firstEffectiveSubstatementOfType, firstSchemaNode, firstSubstatementOfType, firstSubstatementOfType, get, getAll

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.AugmentationSchema

getDescription, getReference, getStatus

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DataNodeContainer

getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses

Constructor Detail

AugmentEffectiveStatementImpl

public AugmentEffectiveStatementImpl(StmtContext<SchemaNodeIdentifier,AugmentStatement,EffectiveStatement<SchemaNodeIdentifier,AugmentStatement>> ctx)

Method Detail

getOriginalDefinition

public com.google.common.base.Optional<AugmentationSchema> getOriginalDefinition()

Description copied from interface: AugmentationSchema

Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.

Specified by:

getOriginalDefinition in interface AugmentationSchema

Returns:

Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.

getTargetPath

public SchemaPath getTargetPath()

Description copied from interface: AugmentationSchema

Returns augmentation schema path.

Specified by:

getTargetPath in interface AugmentationSchema

Returns:

SchemaPath that identifies a node in the schema tree. This node is called the augment's target node. The target node MUST be either a container, list, choice, case, input, output, or notification node. It is augmented with the nodes defined as child nodes of this AugmentationSchema.

getWhenCondition

public RevisionAwareXPath getWhenCondition()

Description copied from interface: AugmentationSchema

Returns when statement.

If when condition is present node defined by the parent data definition statement is only valid when the returned XPath expression conceptually evaluates to "true" for a particular instance, then the node defined by the parent data definition statement is valid; otherwise, it is not.

Specified by:

getWhenCondition in interface AugmentationSchema

Returns:

XPath condition

getUnknownSchemaNodes

@Nonnull
public List<UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: AugmentationSchema

Returns unknown schema node children.

Specified by:

getUnknownSchemaNodes in interface AugmentationSchema

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

Returns:

collection of all unknown nodes defined in this augmentation

getNamespace

public URI getNamespace()

Specified by:

getNamespace in interface NamespaceRevisionAware

getActions

public Set<ActionDefinition> getActions()

Description copied from interface: ActionNodeContainer

All implementations should override this method. The default definition of this method is used in YANG 1.0 (RFC6020) implementations of AugmentationSchema, GroupingDefinition, ListSchemaNode and ContainerSchemaNode which do not allow action statements. These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain action statements.

The default definition is also used by implementations of ContainerSchemaNode which do not support action statements such as InputEffectiveStatementImpl, OutputEffectiveStatementImpl and SchemaContext.

Specified by:

getActions in interface ActionNodeContainer

Returns:

set of action nodes

getNotifications

public Set<NotificationDefinition> getNotifications()

Description copied from interface: NotificationNodeContainer

All implementations should override this method. The default definition of this method is used in YANG 1.0 (RFC6020) implementations of AugmentationSchema, GroupingDefinition, ListSchemaNode and ContainerSchemaNode which do not allow notification statements. These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain notification statements.

The default definition is also used by implementations of ContainerSchemaNode which do not support notification statements such as InputEffectiveStatementImpl and OutputEffectiveStatementImpl.

Specified by:

getNotifications in interface NotificationNodeContainer

Returns:

set of notification nodes

getRevision

public Date getRevision()

Specified by:

getRevision in interface NamespaceRevisionAware

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getTypeDefinitions

public final Set<TypeDefinition<?>> getTypeDefinitions()

Description copied from interface: DataNodeContainer

Returns set of all newly defined types within this DataNodeContainer.

Specified by:

getTypeDefinitions in interface DataNodeContainer

Returns:

typedef statements in lexicographical order

getChildNodes

public final Set<DataSchemaNode> getChildNodes()

Description copied from interface: DataNodeContainer

Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection, each node is guaranteed to be present at most once.

Specified by:

getChildNodes in interface DataNodeContainer

Returns:

child nodes in lexicographical order

getGroupings

public final Set<GroupingDefinition> getGroupings()

Description copied from interface: DataNodeContainer

Returns set of all groupings defined within this DataNodeContainer.

Specified by:

getGroupings in interface DataNodeContainer

Returns:

grouping statements in lexicographical order

getDataChildByName

public final DataSchemaNode getDataChildByName(QName name)

Description copied from interface: DataNodeContainer

Returns the child node corresponding to the specified name.

Specified by:

getDataChildByName in interface DataNodeContainer

Parameters:

name - QName of child

Returns:

child node of this DataNodeContainer if child with given name is present, null otherwise

getUses

public Set<UsesNode> getUses()

Description copied from interface: DataNodeContainer

Returns grouping nodes used ny this container.

Specified by:

getUses in interface DataNodeContainer

Returns:

Set of all uses nodes defined within this DataNodeContainer