org.opendaylight.yangtools.yang.parser.rfc7950.stmt.choice

Class ImplicitCaseSchemaNode

java.lang.Object

org.opendaylight.yangtools.yang.parser.rfc7950.stmt.choice.ImplicitCaseSchemaNode

All Implemented Interfaces:

AddedByUsesAware, AugmentationTarget, CaseSchemaNode, CopyableNode, DataNodeContainer, DataSchemaNode, DerivableSchemaNode, DocumentedNode, DocumentedNode.WithStatus, SchemaNode, WhenConditionAware

public final class ImplicitCaseSchemaNode
extends Object
implements CaseSchemaNode, DerivableSchemaNode

Nested Class Summary

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

DocumentedNode.WithStatus

Constructor Summary

Constructors

Constructor and Description
ImplicitCaseSchemaNode(DataSchemaNode caseShorthandNode)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Optional<DataSchemaNode>	findDataChildByName(QName name) Returns the child node corresponding to the specified name.
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.
Optional<? extends SchemaNode>	getOriginal() If this node is added by uses, returns original node definition from grouping where it was defined.
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.
int	hashCode()
boolean	isAddedByUses() Deprecated.
boolean	isAugmenting() Deprecated.
boolean	isConfiguration() Returns true if the data represents configuration data, otherwise returns false.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

Constructor Detail

ImplicitCaseSchemaNode

public ImplicitCaseSchemaNode(DataSchemaNode caseShorthandNode)

Method Detail

isAugmenting

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

getQName

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

public 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

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

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

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

getAvailableAugmentations

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

getOriginal

public Optional<? extends SchemaNode> getOriginal()

Description copied from interface: DerivableSchemaNode

If this node is added by uses, returns original node definition from grouping where it was defined.

Specified by:

getOriginal in interface DerivableSchemaNode

Returns:

original node definition from grouping if this node is added by uses, Optional.absent otherwise

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object