org.opendaylight.yangtools.yang.model.util

Class EffectiveAugmentationSchema

java.lang.Object

org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema

All Implemented Interfaces:

ActionNodeContainer, AugmentationSchema, DataNodeContainer, NotificationNodeContainer

public final class EffectiveAugmentationSchema
extends Object
implements AugmentationSchema

Proxy for AugmentationSchema. Child node schemas are replaced with actual schemas from parent.

Constructor Summary

Constructors

Constructor and Description
EffectiveAugmentationSchema(AugmentationSchema augmentSchema, Set<DataSchemaNode> realChildSchemas)

Method Summary

Modifier and Type	Method and Description
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.
String	getDescription() Returns description text.
Set<GroupingDefinition>	getGroupings() Returns set of all groupings defined within this DataNodeContainer.
com.google.common.base.Optional<AugmentationSchema>	getOriginalDefinition() Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.
String	getReference() Returns reference text.
Status	getStatus() Returns status of this node.
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.

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.model.api.NotificationNodeContainer

getNotifications

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

getActions

Constructor Detail

EffectiveAugmentationSchema

public EffectiveAugmentationSchema(AugmentationSchema augmentSchema,
                                   Set<DataSchemaNode> realChildSchemas)

Method Detail

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

getDescription

public String getDescription()

Description copied from interface: AugmentationSchema

Returns description text.

Specified by:

getDescription in interface AugmentationSchema

Returns:

textual description of this augment.

getReference

public String getReference()

Description copied from interface: AugmentationSchema

Returns reference text.

Specified by:

getReference in interface AugmentationSchema

Returns:

textual cross-reference to an external document that provides additional information relevant to this node.

getStatus

public Status getStatus()

Description copied from interface: AugmentationSchema

Returns status of this node.

Specified by:

getStatus in interface AugmentationSchema

Returns:

actual status of this node.

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.

getUnknownSchemaNodes

public List<UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: AugmentationSchema

Returns unknown schema node children.

Specified by:

getUnknownSchemaNodes in interface AugmentationSchema

Returns:

collection of all unknown nodes defined in this augmentation

getTypeDefinitions

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

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.