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

Interface OrderedNodeContainer<V extends NormalizedNode>

Type Parameters:

V - child type

All Superinterfaces:

Identifiable<YangInstanceIdentifier.PathArgument>, ItemOrder<ItemOrder.Ordered>, ItemOrder.Ordered, MixinNode, NormalizedNode, NormalizedNodeContainer<V>, OrderingAware, OrderingAware.User, PrettyTreeAware

All Known Subinterfaces:

UnkeyedListNode, UserLeafSetNode<T>, UserMapNode

All Known Implementing Classes:

ImmutableUnkeyedListNodeBuilder.EmptyImmutableUnkeyedListNode, ImmutableUnkeyedListNodeBuilder.ImmutableUnkeyedListNode, ImmutableUserLeafSetNodeBuilder.ImmutableUserLeafSetNode, ImmutableUserMapNodeBuilder.ImmutableUserMapNode

public non-sealed interface OrderedNodeContainer<V extends NormalizedNode>
extends NormalizedNodeContainer<V>, MixinNode, OrderingAware.User

A NormalizedNodeContainer which preserves user supplied ordering and allows addressing of child elements by position. All implementations of this interface must also implement OrderingAware.User.

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
@NonNull V	childAt(int position)	Returns child node by position.
boolean	equals(Object obj)	ItemOrder has impact on ItemOrder.equals(Object).
YangInstanceIdentifier.NodeIdentifier	getIdentifier()	Return this objects Identifier.
int	hashCode()	ItemOrder has impact on ItemOrder.hashCode().

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

itemOrder

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

contract

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

body, isEmpty, size

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 Details

getIdentifier

YangInstanceIdentifier.NodeIdentifier getIdentifier()

Description copied from interface: Identifiable

Return this objects Identifier.

Specified by:

getIdentifier in interface Identifiable<V extends NormalizedNode>

Specified by:

getIdentifier in interface NormalizedNode

Returns:

Object's identifier, must not be null.

childAt

@NonNull V childAt(int position)

Returns child node by position.

Parameters:

position - Position of child node

Returns:

Child Node

Throws:

IndexOutOfBoundsException - Out of bound Exception

hashCode

int hashCode()

Description copied from interface: ItemOrder.Ordered

ItemOrder has impact on ItemOrder.hashCode().

Hash code contract of ItemOrder.Ordered objects should be sensitive to item order. In general similar to List.hashCode() (in the must reading of sensitivity. need not reading of sensitivity could also be implemented as Map.hashCode() in case of a map-like container.

Specified by:

hashCode in interface ItemOrder<V extends NormalizedNode>

Specified by:

hashCode in interface ItemOrder.Ordered

Overrides:

hashCode in class Object

equals

boolean equals(Object obj)

Description copied from interface: ItemOrder.Ordered

ItemOrder has impact on ItemOrder.equals(Object).

Equality contract of ItemOrder.Ordered objects must be sensitive to item order, similar to List.equals(Object).

Specified by:

equals in interface ItemOrder<V extends NormalizedNode>

Specified by:

equals in interface ItemOrder.Ordered

Overrides:

equals in class Object