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

Interface MapNode

All Superinterfaces:

DataContainerChild, DistinctNodeContainer<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>, Identifiable<YangInstanceIdentifier.PathArgument>, MixinNode, NormalizedNode, NormalizedNodeContainer<MapEntryNode>, OrderingAware, PrettyTreeAware

All Known Subinterfaces:

SystemMapNode, UserMapNode

All Known Implementing Classes:

ImmutableMapNodeBuilder.ImmutableMapNode, ImmutableUserMapNodeBuilder.ImmutableUserMapNode

public interface MapNode
extends DistinctNodeContainer<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>, DataContainerChild, MixinNode

Containment node, which contains MapEntryNode of the same type, which may be quickly retrieved using a key.

This node maps to the list node in YANG schema, schema and semantics of this node, its children and key construction is defined by YANG list statement and its key and ordered-by substatements.

Nested Class Summary

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
@NonNull Map<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>	asMap()	Return a Map view of this node.
default Collection<@NonNull MapEntryNode>	body()	Returns the body of this node.
Class<? extends MapNode>	contract()	Return the contract governing this NormalizedNode instance.
YangInstanceIdentifier.NodeIdentifier	getIdentifier()	Return this objects Identifier.
default boolean	isEmpty()	Determine whether this container body is empty.
default int	size()	Return the logical size of this container body.

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

childByArg, findChildByArg, getChildByArg

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

ordering

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

prettyTree

Method Detail

contract

Class<? extends MapNode> contract()

Description copied from interface: NormalizedNode

Return the contract governing this NormalizedNode instance.

Specified by:

contract in interface NormalizedNode

Returns:

A class identifying the NormalizedNode contract.

getIdentifier

YangInstanceIdentifier.NodeIdentifier getIdentifier()

Description copied from interface: Identifiable

Return this objects Identifier.

Specified by:

getIdentifier in interface Identifiable<YangInstanceIdentifier.PathArgument>

Specified by:

getIdentifier in interface NormalizedNode

Returns:

Object's identifier, must not be null.

asMap

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

Returns:

Map view of this node.

body

default Collection<@NonNull MapEntryNode> body()

Description copied from interface: DistinctNodeContainer

Returns the body of this node. While the return value specifies Object, this method's return value has further semantics. The returned object must be a well-published contract, such as String, Collection<NormalizedNode> or DOMSource.

Returns iteration of all child nodes. Order of returned child nodes may be defined by subinterfaces.

All nodes returned in this iterable, MUST also be accessible via DistinctNodeContainer.childByArg(PathArgument) using their associated identifier.

Specified by:

body in interface DistinctNodeContainer<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>

Specified by:

body in interface NormalizedNode

Specified by:

body in interface NormalizedNodeContainer<MapEntryNode>

Returns:

Iteration of all child nodes

size

default int size()

Description copied from interface: NormalizedNodeContainer

Return the logical size of this container body. The default implementation defers to body().size().

Specified by:

size in interface NormalizedNodeContainer<MapEntryNode>

Returns:

Size of this container's body.

isEmpty

default boolean isEmpty()

Description copied from interface: NormalizedNodeContainer

Determine whether this container body is empty. The default implementation defers to body().isEmpty().

Specified by:

isEmpty in interface NormalizedNodeContainer<MapEntryNode>

Returns:

True if this container has an empty body.