Package org.opendaylight.yangtools.yang.data.api.schema

Interface UserMapNode

All Superinterfaces:

DataContainerChild, DistinctNodeContainer<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>, Identifiable<YangInstanceIdentifier.PathArgument>, ItemOrder<ItemOrder.Ordered>, ItemOrder.Ordered, MapNode, MixinNode, NormalizedNode, NormalizedNodeContainer<MapEntryNode>, OrderedNodeContainer<MapEntryNode>, OrderingAware, OrderingAware.User, PrettyTreeAware

All Known Implementing Classes:

ImmutableUserMapNodeBuilder.ImmutableUserMapNode

public interface UserMapNode
extends MapNode, OrderedNodeContainer<MapEntryNode>

MapNode which additionally preserves user-supplied ordering. This node represents a data instance of a list with ordered-by user; substatement and a key definition.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.concepts.ItemOrder

ItemOrder.Ordered, ItemOrder.Unordered

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.data.api.schema.OrderingAware

OrderingAware.System, OrderingAware.User

Method Summary

Modifier and Type	Method	Description
Map<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>	asMap()	Return a Map view of this node.
default Class<UserMapNode>	contract()	Return the contract governing this NormalizedNode instance.

Methods inherited from interface org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer

childByArg, findChildByArg

Methods inherited from interface org.opendaylight.yangtools.concepts.ItemOrder.Ordered

itemOrder

Methods inherited from interface org.opendaylight.yangtools.yang.data.api.schema.MapNode

body, getIdentifier, isEmpty, size

Methods inherited from interface org.opendaylight.yangtools.yang.data.api.schema.OrderedNodeContainer

childAt, equals, getIdentifier, hashCode

Methods inherited from interface org.opendaylight.yangtools.yang.data.api.schema.OrderingAware.User

ordering

Methods inherited from interface org.opendaylight.yangtools.concepts.PrettyTreeAware

prettyTree

Method Detail

contract

default Class<UserMapNode> contract()

Description copied from interface: NormalizedNode

Return the contract governing this NormalizedNode instance.

Specified by:

contract in interface MapNode

Specified by:

contract in interface NormalizedNode

Returns:

A class identifying the NormalizedNode contract.

asMap

Map<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode> asMap()

Return a Map view of this node. Note that the iteration order of the returned is map is not defined in this interface.

The implementation is required to define a user-visible iteration order, which must match OrderedNodeContainer.childAt(int).

Specified by:

asMap in interface MapNode

Returns:

Map view of this node.