org.opendaylight.yangtools.yang.model.api

Interface ChoiceSchemaNode

All Superinterfaces:

AugmentationTarget, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, SchemaNode

All Known Implementing Classes:

ChoiceEffectiveStatementImpl

public interface ChoiceSchemaNode
extends DataSchemaNode, AugmentationTarget

A ChoiceSchemaNode defines a set of alternatives. It consists of a number of branches defined as ChoiceCaseSchemaNode objects.

Nested Class Summary

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

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method and Description
ChoiceCaseNode	getCaseNodeByName(QName name) Returns the concrete case according to specified Q name.
ChoiceCaseNode	getCaseNodeByName(String name) Returns the concrete case according to specified name.
Set<ChoiceCaseNode>	getCases() Returns cases of choice.
String	getDefaultCase() Returns name of case which is in the choice specified as default.

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

getConstraints, isAddedByUses, isAugmenting, isConfiguration

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

getPath, getQName

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

getStatus

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

getDescription, getReference, getUnknownSchemaNodes

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

getAvailableAugmentations

Method Detail

getCases

Set<ChoiceCaseNode> getCases()

Returns cases of choice.

Returns:

set of ChoiceCaseNode objects defined in this node which represents set of arguments of the YANG case substatement of the choice statement

getCaseNodeByName

ChoiceCaseNode getCaseNodeByName(QName name)

Returns the concrete case according to specified Q name.

Parameters:

name - QName of seeked Choice Case Node

Returns:

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

getCaseNodeByName

ChoiceCaseNode getCaseNodeByName(String name)

Returns the concrete case according to specified name.

Parameters:

name - name of seeked child as String

Returns:

child case node (or local name of case node) of this Choice if child with given name is present, null otherwise

getDefaultCase

String getDefaultCase()

Returns name of case which is in the choice specified as default.

Returns:

string with the name of case which is specified in the argument of the YANG default substatement of choice statement.