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

Class ContainerEffectiveStatementImpl

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

All Implemented Interfaces:

ActionNodeContainer, AugmentationTarget, ContainerSchemaNode, DataNodeContainer, DataSchemaNode, DerivableSchemaNode, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatement<QName,ContainerStatement>, ModelStatement<QName>, NotificationNodeContainer, SchemaNode

public final class ContainerEffectiveStatementImpl
extends AbstractEffectiveDocumentedNode<A,D>
implements DerivableSchemaNode

Nested Class Summary

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

DocumentedNode.WithStatus

Constructor Summary

Constructors

Constructor and Description
ContainerEffectiveStatementImpl(StmtContext<QName,ContainerStatement,EffectiveStatement<QName,ContainerStatement>> ctx)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<ActionDefinition>	getActions() All implementations should override this method.
Set<AugmentationSchema>	getAvailableAugmentations() Returns augmentations targeting this element.
Set<DataSchemaNode>	getChildNodes() Returns set of all child nodes defined within this DataNodeContainer.
ConstraintDefinition	getConstraints() Returns the constraints associated with Data Schema Node.
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.
Set<NotificationDefinition>	getNotifications() All implementations should override this method.
com.google.common.base.Optional<ContainerSchemaNode>	getOriginal() If this node is added by uses, returns original node definition from grouping where it was defined.
SchemaPath	getPath() Returns the schema path of the instance of the type SchemaNode SchemaNode.
QName	getQName() Returns QName of the instance of the type SchemaNode.
Set<TypeDefinition<?>>	getTypeDefinitions() Returns set of all newly defined types within this DataNodeContainer.
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown schema nodes which belongs to this instance.
Set<UsesNode>	getUses() Returns grouping nodes used ny this container.
int	hashCode()
boolean	isAddedByUses() Returns true if the data node was added by uses statement, otherwise returns false.
boolean	isAugmenting() Returns true if the data node was added by augmentation, otherwise returns false.
boolean	isConfiguration() Returns true if the data represents configuration data, otherwise returns false.
boolean	isPresenceContainer() Returns true if this container is marked as presence.
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.DataSchemaNode

getConstraints, isAddedByUses, isAugmenting, isConfiguration

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

getPath, getQName

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

getStatus

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

getDescription, getReference, getUnknownSchemaNodes

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

getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses

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

getAvailableAugmentations

Constructor Detail

ContainerEffectiveStatementImpl

public ContainerEffectiveStatementImpl(StmtContext<QName,ContainerStatement,EffectiveStatement<QName,ContainerStatement>> ctx)

Method Detail

getOriginal

public com.google.common.base.Optional<ContainerSchemaNode> getOriginal()

Description copied from interface: DerivableSchemaNode

If this node is added by uses, returns original node definition from grouping where it was defined.

Specified by:

getOriginal in interface DerivableSchemaNode

Returns:

original node definition from grouping if this node is added by uses, Optional.absent otherwise

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

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

isPresenceContainer

public boolean isPresenceContainer()

Description copied from interface: ContainerSchemaNode

Returns true if this container is marked as presence.

Specified by:

isPresenceContainer in interface ContainerSchemaNode

Returns:

true, if presence of this container has an explicit meaning, false otherwise

getQName

@Nonnull
public QName getQName()

Description copied from interface: SchemaNode

Returns QName of the instance of the type SchemaNode.

Specified by:

getQName in interface SchemaNode

Returns:

QName with the name of the schema node

getPath

@Nonnull
public SchemaPath getPath()

Description copied from interface: SchemaNode

Returns the schema path of the instance of the type SchemaNode SchemaNode.

Specified by:

getPath in interface SchemaNode

Returns:

schema path of the schema node

isAugmenting

public boolean isAugmenting()

Description copied from interface: DataSchemaNode

Returns true if the data node was added by augmentation, otherwise returns false.

Specified by:

isAugmenting in interface DataSchemaNode

Returns:

true if the data node was added by augmentation, otherwise returns false

isAddedByUses

public boolean isAddedByUses()

Description copied from interface: DataSchemaNode

Returns true if the data node was added by uses statement, otherwise returns false.

Specified by:

isAddedByUses in interface DataSchemaNode

Returns:

true if the data node was added by uses statement, otherwise returns false

isConfiguration

public boolean isConfiguration()

Description copied from interface: DataSchemaNode

Returns true if the data represents configuration data, otherwise returns false.

Specified by:

isConfiguration in interface DataSchemaNode

Returns:

true if the data represents configuration data, otherwise returns false

getConstraints

public ConstraintDefinition getConstraints()

Description copied from interface: DataSchemaNode

Returns the constraints associated with Data Schema Node.

Specified by:

getConstraints in interface DataSchemaNode

Returns:

the constraints associated with Data Schema Node

getAvailableAugmentations

public Set<AugmentationSchema> getAvailableAugmentations()

Description copied from interface: AugmentationTarget

Returns augmentations targeting this element.

Specified by:

getAvailableAugmentations in interface AugmentationTarget

Returns:

set of augmentations targeting this element.

getUnknownSchemaNodes

@Nonnull
public List<UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: DocumentedNode

Returns unknown schema nodes which belongs to this instance.

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

Returns:

list of unknown schema nodes defined under this node.

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