Module org.opendaylight.yangtools.yang.model.api

Package org.opendaylight.yangtools.yang.model.api

Interface ListSchemaNode

All Superinterfaces:

ActionNodeContainer, AddedByUsesAware, AugmentationTarget, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, EffectiveStatementEquivalent<ListEffectiveStatement>, ElementCountConstraintAware, MustConstraintAware, NotificationNodeContainer, SchemaNode, UserOrderedAware<ListEffectiveStatement>, WhenConditionAware

public interface ListSchemaNode
extends DataNodeContainer, AugmentationTarget, DataSchemaNode, ActionNodeContainer, NotificationNodeContainer, ElementCountConstraintAware, MustConstraintAware, UserOrderedAware<ListEffectiveStatement>

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	Description
@NonNull List<@NonNull QName>	getKeyDefinition()	Returns the list of leaf identifiers.
@NonNull Collection<? extends @NonNull UniqueEffectiveStatement>	getUniqueConstraints()	Returns unique constraints.

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

findAction, getActions

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

isAddedByUses

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

getAvailableAugmentations

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

isAugmenting

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

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

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

effectiveConfig, isConfiguration

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

getDescription, getReference, getUnknownSchemaNodes

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

getStatus

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

asEffectiveStatement

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

getElementCountConstraint

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

getMustConstraints

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

findNotification, getNotifications

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

getQName

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

isUserOrdered

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

getWhenCondition

Method Detail

getKeyDefinition

@NonNull List<@NonNull 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.

getUniqueConstraints

@NonNull Collection<? extends @NonNull UniqueEffectiveStatement> getUniqueConstraints()

Returns unique constraints.

Returns:

Collection of unique constraints of this list schema node