OperationAsContainer (yangtools 3.0.0-SNAPSHOT API)

java.lang.Object
- com.google.common.collect.ForwardingObject
- - org.opendaylight.yangtools.yang.data.util.OperationAsContainer

All Implemented Interfaces:

ActionNodeContainer, AddedByUsesAware, AugmentationTarget, ContainerSchemaNode, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, MustConstraintAware, NotificationNodeContainer, OperationDefinition, SchemaNode, WhenConditionAware
```
@Beta
public class OperationAsContainer
extends com.google.common.collect.ForwardingObject
implements ContainerSchemaNode, OperationDefinition
```

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected OperationDefinition`	`delegate()`
`Optional<DataSchemaNode>`	`findDataChildByName(QName name)` Returns the child node corresponding to the specified name.
`Set<ActionDefinition>`	`getActions()` Return the set of actions.
`Set<AugmentationSchemaNode>`	`getAvailableAugmentations()` Returns augmentations targeting this element.
`Collection<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.
`ContainerSchemaNode`	`getInput()` Returns definition of input parameters for this operation.
`Collection<MustDefinition>`	`getMustConstraints()` Specifies the rules which the node which contains `must` YANG substatement has to match.
`Set<NotificationDefinition>`	`getNotifications()` Return the set of notifications in this container, keyed by QName.
`ContainerSchemaNode`	`getOutput()` Returns definition of output parameters for this operation.
`SchemaPath`	`getPath()` Returns the schema path of the instance of the type `SchemaNode`.
`QName`	`getQName()` Returns QName of the instance of the type `SchemaNode`.
`Optional<String>`	`getReference()` Returns the value of the argument of YANG `reference` keyword.
`Status`	`getStatus()` Returns status of the instance of the type `SchemaNode`.
`Set<TypeDefinition<?>>`	`getTypeDefinitions()` Returns set of all newly defined types within this DataNodeContainer.
`Set<UsesNode>`	`getUses()` Returns grouping nodes used ny this container.
`Optional<RevisionAwareXPath>`	`getWhenCondition()` Returns when statement.
`boolean`	`isAddedByUses()` Deprecated.
`boolean`	`isAugmenting()` Deprecated.
`boolean`	`isConfiguration()` Returns `true` if the data represents configuration data, otherwise returns `false`.
`boolean`	`isPresenceContainer()` Returns true if this container is marked as presence.
`static OperationAsContainer`	`of(OperationDefinition delegate)`

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.model.api.DataNodeContainer
findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName

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

- Method Detail
  - of
```
public static OperationAsContainer of(OperationDefinition delegate)
```
  - delegate
```
protected final OperationDefinition delegate()
```
    Specified by:
    
    delegate in class com.google.common.collect.ForwardingObject
  - getDescription
```
public final 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 final 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.
  - 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
    
    Specified by:
    
    getTypeDefinitions in interface OperationDefinition
    
    Returns:
    
    typedef statements 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
    
    Specified by:
    
    getGroupings in interface OperationDefinition
    
    Returns:
    
    grouping statements in lexicographical order
  - getStatus
```
public final 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
  - getInput
```
public final ContainerSchemaNode getInput()
```
    Description copied from interface: OperationDefinition
    
    Returns definition of input parameters for this operation.
    
    Specified by:
    
    getInput in interface OperationDefinition
    
    Returns:
    
    Definition of input parameters for this operation. The substatements of input define nodes under the operation's input node.
  - getOutput
```
public final ContainerSchemaNode getOutput()
```
    Description copied from interface: OperationDefinition
    
    Returns definition of output parameters for this operation.
    
    Specified by:
    
    getOutput in interface OperationDefinition
    
    Returns:
    
    Definition of output parameters for this operation. The substatements of output define nodes under the operation's output node.
  - getQName
```
public final 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
```
public final SchemaPath getPath()
```
    Description copied from interface: SchemaNode
    
    Returns the schema path of the instance of the type SchemaNode.
    
    Specified by:
    
    getPath in interface SchemaNode
    
    Returns:
    
    schema path of the schema node
  - findDataChildByName
```
public final 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
  - getAvailableAugmentations
```
public final Set<AugmentationSchemaNode> getAvailableAugmentations()
```
    Description copied from interface: AugmentationTarget
    
    Returns augmentations targeting this element.
    
    Specified by:
    
    getAvailableAugmentations in interface AugmentationTarget
    
    Returns:
    
    set of augmentations targeting this element.
  - isPresenceContainer
```
public final 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
  - getChildNodes
```
public final Collection<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
  - isAugmenting
```
@Deprecated
public final boolean isAugmenting()
```
    Deprecated.
    
    Description copied from interface: CopyableNode
    
    Returns true if this node was added by augmentation, otherwise returns false.
    
    Specified by:
    
    isAugmenting in interface CopyableNode
    
    Returns:
    
    true if this node was added by augmentation, otherwise returns false
  - isAddedByUses
```
@Deprecated
public final boolean isAddedByUses()
```
    Deprecated.
    
    Description copied from interface: AddedByUsesAware
    
    Returns true if this node was added by uses statement, otherwise returns false.
    
    Specified by:
    
    isAddedByUses in interface AddedByUsesAware
    
    Returns:
    
    true if this node was added by uses statement, otherwise returns false
  - isConfiguration
```
public final 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
  - getActions
```
public final 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 final 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
  - getMustConstraints
```
public final Collection<MustDefinition> getMustConstraints()
```
    Description copied from interface: MustConstraintAware
    
    Specifies the rules which the node which contains must YANG substatement has to match.
    
    Specified by:
    
    getMustConstraints in interface MustConstraintAware
    
    Returns:
    
    collection of MustDefinition (XPath) instances which represents the concrete data constraints
  - getWhenCondition
```
public final 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

Class OperationAsContainer

Nested Class Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Method Detail

of

delegate

getDescription

getReference

getTypeDefinitions

getGroupings

getStatus

getInput

getOutput

getQName

getPath

findDataChildByName

getUses

getAvailableAugmentations

isPresenceContainer

getChildNodes

isAugmenting

isAddedByUses

isConfiguration

getActions

getNotifications

getMustConstraints

getWhenCondition