org.opendaylight.yangtools.yang.model.api

Interface ListSchemaNode

All Superinterfaces:

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

All Known Implementing Classes:

ListEffectiveStatementImpl

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

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

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

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

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

getNotifications

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

getActions

Method Detail

getKeyDefinition

List<QName> getKeyDefinition()

Returns the list of leaf identifiers.

Returns:

List of QNames of leaf identifiers of this list

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
default Collection<UniqueConstraint> getUniqueConstraints()

Returns unique constraints.

Returns:

Collection of unique constraints of this list schema node