Package org.opendaylight.yangtools.yang.data.util

Class OperationAsContainer

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.yangtools.yang.data.util.OperationAsContainer

All Implemented Interfaces:

ActionNodeContainer, AddedByUsesAware, AugmentationTarget, ContainerLike, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, MustConstraintAware, NotificationNodeContainer, OperationDefinition, SchemaNode, WhenConditionAware

@Beta
public class OperationAsContainer
extends ForwardingObject
implements OperationDefinition

Nested Class Summary

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

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method	Description
final DataSchemaNode	dataChildByName(QName name)	Returns the child node corresponding to the specified name.
protected final @NonNull OperationDefinition	delegate()
final Optional<Boolean>	effectiveConfig()	Return the effective value of config substatement, if applicable.
final Collection<? extends ActionDefinition>	getActions()	Return the set of actions.
final Collection<? extends AugmentationSchemaNode>	getAvailableAugmentations()	Returns augmentations targeting this element.
final Collection<? extends DataSchemaNode>	getChildNodes()	Returns set of all child nodes defined within this DataNodeContainer.
final Optional<String>	getDescription()	Returns the value of the argument of YANG description keyword.
final Collection<? extends @NonNull GroupingDefinition>	getGroupings()	Returns the set of grouping statements declared under this operation.
final InputSchemaNode	getInput()	Returns definition of input parameters for this operation.
final Collection<? extends @NonNull MustDefinition>	getMustConstraints()	Specifies the rules which the node which contains must YANG substatement has to match.
final Collection<? extends NotificationDefinition>	getNotifications()	Return the set of notifications in this container, keyed by QName.
final OutputSchemaNode	getOutput()	Returns definition of output parameters for this operation.
final QName	getQName()	Returns QName of the instance of the type SchemaNode.
final Optional<String>	getReference()	Returns the value of the argument of YANG reference keyword.
final Status	getStatus()	Returns status of the instance of the type SchemaNode.
final Collection<? extends @NonNull TypeDefinition<?>>	getTypeDefinitions()	Returns the set of type definitions declared under this operation.
final Collection<? extends UsesNode>	getUses()	Returns grouping nodes used ny this container.
final Optional<? extends YangXPathExpression.QualifiedBound>	getWhenCondition()	Returns when statement.
final boolean	isAddedByUses()	Deprecated, for removal: This API element is subject to removal in a future version.
final boolean	isAugmenting()	Deprecated.
static @NonNull 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.ActionNodeContainer

findAction

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

findDataChildByName, findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getDataChildByName

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

isConfiguration

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

getDescription, getReference, getUnknownSchemaNodes

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

getStatus

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

findNotification

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

getQName

Method Details

of

public static @NonNull OperationAsContainer of(OperationDefinition delegate)

delegate

protected final @NonNull OperationDefinition delegate()

getTypeDefinitions

public final Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions()

Description copied from interface: OperationDefinition

Returns the set of type definitions declared under this operation.

Specified by:

getTypeDefinitions in interface DataNodeContainer

Specified by:

getTypeDefinitions in interface OperationDefinition

Returns:

Set of type definitions declared under this operation.

getGroupings

public final Collection<? extends @NonNull GroupingDefinition> getGroupings()

Description copied from interface: OperationDefinition

Returns the set of grouping statements declared under this operation.

Specified by:

getGroupings in interface DataNodeContainer

Specified by:

getGroupings in interface OperationDefinition

Returns:

Set of grouping statements declared under this operation.

getInput

public final InputSchemaNode 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 OutputSchemaNode 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.

dataChildByName

public final DataSchemaNode dataChildByName(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. This is consistent with schema tree.

Specified by:

dataChildByName in interface DataNodeContainer

Parameters:

name - QName of child

Returns:

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

getAvailableAugmentations

public final Collection<? extends 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.

getChildNodes

public final Collection<? extends 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

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.

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

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

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(forRemoval=true)
public final boolean isAddedByUses()

Deprecated, for removal: This API element is subject to removal in a future version.

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

effectiveConfig

public final Optional<Boolean> effectiveConfig()

Description copied from interface: DataSchemaNode

Return the effective value of config substatement, if applicable.

Specified by:

effectiveConfig in interface DataSchemaNode

Returns:

Effective config value, or Optional.empty() not applicable.

getActions

public final Collection<? extends 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 Collection<? extends 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

getUses

public final Collection<? extends 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

getMustConstraints

public final Collection<? extends @NonNull 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<? extends YangXPathExpression.QualifiedBound> 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