org.opendaylight.yangtools.yang.data.util

Class RpcAsContainer

java.lang.Object

org.opendaylight.yangtools.yang.data.util.RpcAsContainer

All Implemented Interfaces:

ActionNodeContainer, AugmentationTarget, ContainerSchemaNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, NotificationNodeContainer, SchemaNode

public final class RpcAsContainer
extends Object
implements ContainerSchemaNode

Nested Class Summary

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

DocumentedNode.WithStatus

Constructor Summary

Constructors

Constructor and Description
RpcAsContainer(RpcDefinition parentNode)

Method Summary

Modifier and Type	Method and Description
Set<AugmentationSchema>	getAvailableAugmentations() Returns augmentations targeting this element.
Collection<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.
String	getDescription() All implementations should override this method.
Set<GroupingDefinition>	getGroupings() Returns set of all groupings defined within this DataNodeContainer.
ContainerSchemaNode	getInput()
ContainerSchemaNode	getOutput()
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.
String	getReference() All implementations should override this method.
Status	getStatus() Returns status 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.
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.

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

RpcAsContainer

public RpcAsContainer(RpcDefinition parentNode)

Method Detail

getDescription

public String getDescription()

Description copied from interface: DocumentedNode

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ModuleImport which do not allow a description statement. YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a description statement.

Specified by:

getDescription in interface DocumentedNode

Returns:

string that represents the argument of description statement

getReference

public String getReference()

Description copied from interface: DocumentedNode

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ModuleImport which do not allow a reference statement. YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a reference statement.

Specified by:

getReference in interface DocumentedNode

Returns:

string that represents the argument of reference statement

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

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

getStatus

@Nonnull
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

getInput

public ContainerSchemaNode getInput()

getOutput

public ContainerSchemaNode getOutput()

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

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.

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

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.

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

getChildNodes

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

Specified by:

getChildNodes in interface DataNodeContainer

Returns:

child nodes in lexicographical order

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