org.opendaylight.yangtools.yang.model.api

Interface ListSchemaNode

All Superinterfaces:

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

All Known Implementing Classes:

ListEffectiveStatementImpl

public interface ListSchemaNode
extends DataNodeContainer, AugmentationTarget, DataSchemaNode, NotificationNodeContainer, ActionNodeContainer, ElementCountConstraintAware, MustConstraintAware

Interface describing YANG 'list' statement.

The 'list' statement is used to define an interior data node in the schema tree. A list entry is uniquely identified by the values of the list's keys, if defined.

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
@NonNull List<QName>	getKeyDefinition() Returns the list of leaf identifiers.
@NonNull Collection<UniqueConstraint>	getUniqueConstraints() Returns unique constraints.
boolean	isUserOrdered() YANG 'ordered-by' statement.

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

findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions, getUses

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

getAvailableAugmentations

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

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

isAugmenting

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

isAddedByUses

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

getWhenCondition

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

getNotifications

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

getActions

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

getElementCountConstraint

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

getMustConstraints

Method Detail

getKeyDefinition

@NonNull List<QName> getKeyDefinition()

Returns the list of leaf identifiers.

Returns:

List of QNames of leaf identifiers of this list, empty if the list has no keys.

isUserOrdered

boolean isUserOrdered()

YANG 'ordered-by' statement. It defines whether the order of entries within a list are determined by the user or the system. If not present, default is false.

Returns:

true if ordered-by argument is "user", false otherwise

getUniqueConstraints

@NonNull Collection<UniqueConstraint> getUniqueConstraints()

Returns unique constraints.

Returns:

Collection of unique constraints of this list schema node