EffectiveAugmentationSchema (yangtools 3.0.0-SNAPSHOT API)

java.lang.Object
- org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema

All Implemented Interfaces:

ActionNodeContainer, AugmentationSchemaNode, DataNodeContainer, DocumentedNode, DocumentedNode.WithStatus, NotificationNodeContainer, WhenConditionAware
```
public final class EffectiveAugmentationSchema
extends Object
implements AugmentationSchemaNode
```
Proxy for AugmentationSchema. Child node schemas are replaced with actual schemas from parent.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode
  DocumentedNode.WithStatus

Constructor Summary

Constructors
Constructor and Description

EffectiveAugmentationSchema(AugmentationSchemaNode augmentSchema, Set<DataSchemaNode> realChildSchemas)

Constructors
Constructor and Description
`EffectiveAugmentationSchema(AugmentationSchemaNode augmentSchema, Set<DataSchemaNode> realChildSchemas)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AugmentationSchemaNode`	`create(AugmentationSchemaNode schema, DataNodeContainer parent)` Returns an AugmentationSchemaNode as effective in a parent node.
`Optional<DataSchemaNode>`	`findDataChildByName(QName name)` Returns the child node corresponding to the specified name.
`Set<ActionDefinition>`	`getActions()` Return the set of actions.
`Set<DataSchemaNode>`	`getChildNodes()` Returns set of all child nodes defined within this DataNodeContainer.
`Optional<String>`	`getDescription()` Returns the value of the argument of YANG `description` keyword.
`Set<GroupingDefinition>`	`getGroupings()` Returns set of all groupings defined within this DataNodeContainer.
`Set<NotificationDefinition>`	`getNotifications()` Return the set of notifications in this container, keyed by QName.
`Optional<AugmentationSchemaNode>`	`getOriginalDefinition()` Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.
`Optional<String>`	`getReference()` Returns the value of the argument of YANG `reference` keyword.
`Status`	`getStatus()` Returns status of the instance of the type `SchemaNode`.
`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 nodes which belongs to this instance.
`Set<UsesNode>`	`getUses()` Returns grouping nodes used ny this container.
`Optional<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.DataNodeContainer
findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName

- Constructor Detail
  - EffectiveAugmentationSchema
```
public EffectiveAugmentationSchema(AugmentationSchemaNode augmentSchema,
                                   Set<DataSchemaNode> realChildSchemas)
```
- Method Detail
  - create
```
public static AugmentationSchemaNode create(AugmentationSchemaNode schema,
                                            DataNodeContainer parent)
```
    Returns an AugmentationSchemaNode as effective in a parent node.
    
    Parameters:
    
    schema - Augmentation schema
    
    parent - Parent schema
    
    Returns:
    
    Adjusted Augmentation schema
    
    Throws:
    
    NullPointerException - if any of the arguments is null
  - getWhenCondition
```
public Optional<RevisionAwareXPath> getWhenCondition()
```
    Description copied from interface: WhenConditionAware
    
    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 WhenConditionAware
    
    Returns:
    
    XPath condition
  - getDescription
```
public Optional<String> getDescription()
```
    Description copied from interface: DocumentedNode
    
    Returns the value of the argument of YANG description keyword.
    
    Specified by:
    
    getDescription in interface DocumentedNode
    
    Returns:
    
    string with the description, or empty if description was not provided.
  - getReference
```
public Optional<String> getReference()
```
    Description copied from interface: DocumentedNode
    
    Returns the value of the argument of YANG reference keyword.
    
    Specified by:
    
    getReference in interface DocumentedNode
    
    Returns:
    
    string with reference to some other document, or empty if reference was not provided.
  - getStatus
```
public Status getStatus()
```
    Description copied from interface: DocumentedNode.WithStatus
    
    Returns status of the instance of the type SchemaNode.
    
    Specified by:
    
    getStatus in interface DocumentedNode.WithStatus
    
    Returns:
    
    status of this node which represents the argument of the YANG status substatement
  - getTargetPath
```
public SchemaPath getTargetPath()
```
    Description copied from interface: AugmentationSchemaNode
    
    Returns augmentation schema path.
    
    Specified by:
    
    getTargetPath in interface AugmentationSchemaNode
    
    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: DocumentedNode
    
    Returns unknown schema nodes which belongs to this instance. Default implementation returns an empty list.
    
    Specified by:
    
    getUnknownSchemaNodes in interface DocumentedNode
    
    Returns:
    
    list of unknown schema nodes defined under this node.
  - 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.
    Note that the nodes returned are NOT data nodes, but rather DataSchemaNodes, hence ChoiceSchemaNode and CaseSchemaNode are present instead of their children. This is consistent with schema tree.
    
    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
  - findDataChildByName
```
public Optional<DataSchemaNode> findDataChildByName(QName name)
```
    Description copied from interface: DataNodeContainer
    
    Returns the child node corresponding to the specified name.
    Note that the nodes searched are NOT data nodes, but rather DataSchemaNodes, hence ChoiceSchemaNode and CaseSchemaNode are returned instead of their matching children.
    
    Specified by:
    
    findDataChildByName in interface DataNodeContainer
    
    Parameters:
    
    name - QName of child
    
    Returns:
    
    child node of this DataNodeContainer if child with given name is present, empty 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 Optional<AugmentationSchemaNode> getOriginalDefinition()
```
    Description copied from interface: AugmentationSchemaNode
    
    Returns Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.
    
    Specified by:
    
    getOriginalDefinition in interface AugmentationSchemaNode
    
    Returns:
    
    Augmentation Definition from which this augmentation is derived if augmentation was added transitively via augmented uses.
  - getActions
```
public Set<ActionDefinition> getActions()
```
    Description copied from interface: ActionNodeContainer
    
    Return the set of actions.
    
    Specified by:
    
    getActions in interface ActionNodeContainer
    
    Returns:
    
    set of action nodes
  - getNotifications
```
public Set<NotificationDefinition> getNotifications()
```
    Description copied from interface: NotificationNodeContainer
    
    Return the set of notifications in this container, keyed by QName. RFC7950 specifies that AugmentationSchemaNodes, GroupingDefinitions, ListSchemaNodes and ContainerSchemaNodes can also contain NotificationDefinitions.
    
    Specified by:
    
    getNotifications in interface NotificationNodeContainer
    
    Returns:
    
    set of notification nodes

Class EffectiveAugmentationSchema

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectiveAugmentationSchema

Method Detail

create

getWhenCondition

getDescription

getReference

getStatus

getTargetPath

getUnknownSchemaNodes

getTypeDefinitions

getChildNodes

getGroupings

findDataChildByName

getUses

getOriginalDefinition

getActions

getNotifications