org.opendaylight.yangtools.yang.data.impl.schema

Class ImmutableNodes

java.lang.Object

org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes

public final class ImmutableNodes
extends Object

Method Summary

Modifier and Type	Method and Description
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode	choiceNode(org.opendaylight.yangtools.yang.common.QName name) Create an immutable choice node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode	choiceNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name) Create an immutable choice node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	containerNode(org.opendaylight.yangtools.yang.common.QName name) Create an immutable container node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	containerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name) Create an immutable container node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	fromInstanceId(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id) Convert YangInstanceIdentifier into a normalized node structure.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	fromInstanceId(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> deepestElement) Convert YangInstanceIdentifier into a normalized node structure.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	fromInstanceId(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id, Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> deepestElement) Convert YangInstanceIdentifier into a normalized node structure.
static <T> @NonNull org.opendaylight.yangtools.yang.data.api.schema.LeafNode<T>	leafNode(org.opendaylight.yangtools.yang.common.QName name, T value) Construct immutable leaf node.
static <T> @NonNull org.opendaylight.yangtools.yang.data.api.schema.LeafNode<T>	leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name, T value) Construct immutable leaf node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode	listNode(org.opendaylight.yangtools.yang.common.QName name) Create an immutable list node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode	listNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name) Create an immutable list node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode	mapEntry(org.opendaylight.yangtools.yang.common.QName nodeName, org.opendaylight.yangtools.yang.common.QName keyName, Object keyValue)
static @NonNull DataContainerNodeBuilder<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates,org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode>	mapEntryBuilder()
static @NonNull DataContainerNodeBuilder<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates,org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode>	mapEntryBuilder(org.opendaylight.yangtools.yang.common.QName nodeName, org.opendaylight.yangtools.yang.common.QName keyName, Object keyValue)
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.MapNode	mapNode(org.opendaylight.yangtools.yang.common.QName name) Create an immutable map node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.MapNode	mapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name) Create an immutable map node.
static @NonNull CollectionNodeBuilder<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode,org.opendaylight.yangtools.yang.data.api.schema.MapNode>	mapNodeBuilder()
static @NonNull CollectionNodeBuilder<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode,org.opendaylight.yangtools.yang.data.api.schema.MapNode>	mapNodeBuilder(org.opendaylight.yangtools.yang.common.QName name)
static @NonNull CollectionNodeBuilder<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode,org.opendaylight.yangtools.yang.data.api.schema.MapNode>	mapNodeBuilder(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode	orderedMapNode(org.opendaylight.yangtools.yang.common.QName name) Create immutable ordered map node.
static @NonNull org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode	orderedMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name) Create immutable ordered map node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

mapNodeBuilder

public static @NonNull CollectionNodeBuilder<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode,org.opendaylight.yangtools.yang.data.api.schema.MapNode> mapNodeBuilder()

mapNodeBuilder

public static @NonNull CollectionNodeBuilder<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode,org.opendaylight.yangtools.yang.data.api.schema.MapNode> mapNodeBuilder(org.opendaylight.yangtools.yang.common.QName name)

mapNodeBuilder

public static @NonNull CollectionNodeBuilder<org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode,org.opendaylight.yangtools.yang.data.api.schema.MapNode> mapNodeBuilder(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)

mapNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.MapNode mapNode(org.opendaylight.yangtools.yang.common.QName name)

Create an immutable map node.

Parameters:

name - QName which will be used as node identifier

Returns:

An unordered Map node

mapNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.MapNode mapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)

Create an immutable map node.

Parameters:

name - QName which will be used as node identifier

Returns:

An unordered Map node

orderedMapNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode orderedMapNode(org.opendaylight.yangtools.yang.common.QName name)

Create immutable ordered map node.

Parameters:

name - QName which will be used as node identifier

Returns:

An ordered Map node

orderedMapNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode orderedMapNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)

Create immutable ordered map node.

Parameters:

name - Node identifier

Returns:

An ordered Map node

leafNode

public static <T> @NonNull org.opendaylight.yangtools.yang.data.api.schema.LeafNode<T> leafNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name,
                                                                                                T value)

Construct immutable leaf node.

Type Parameters:

T - Type of leaf node value

Parameters:

name - Identifier of leaf node

value - Value of leaf node

Returns:

Leaf node with supplied identifier and value

leafNode

public static <T> @NonNull org.opendaylight.yangtools.yang.data.api.schema.LeafNode<T> leafNode(org.opendaylight.yangtools.yang.common.QName name,
                                                                                                T value)

Construct immutable leaf node.

Type Parameters:

T - Type of leaf node value

Parameters:

name - QName which will be used as node identifier

value - Value of leaf node.

Returns:

Leaf node with supplied identifier and value

mapEntryBuilder

public static @NonNull DataContainerNodeBuilder<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates,org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> mapEntryBuilder(org.opendaylight.yangtools.yang.common.QName nodeName,
                                                                                                                                                                                                                           org.opendaylight.yangtools.yang.common.QName keyName,
                                                                                                                                                                                                                           Object keyValue)

mapEntryBuilder

public static @NonNull DataContainerNodeBuilder<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates,org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode> mapEntryBuilder()

mapEntry

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode mapEntry(org.opendaylight.yangtools.yang.common.QName nodeName,
                                                                                             org.opendaylight.yangtools.yang.common.QName keyName,
                                                                                             Object keyValue)

containerNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode containerNode(org.opendaylight.yangtools.yang.common.QName name)

Create an immutable container node.

Parameters:

name - QName which will be used as node identifier

Returns:

A container node

containerNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ContainerNode containerNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)

Create an immutable container node.

Parameters:

name - Node identifier

Returns:

A container node

choiceNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode choiceNode(org.opendaylight.yangtools.yang.common.QName name)

Create an immutable choice node.

Parameters:

name - QName which will be used as node identifier

Returns:

A choice node

choiceNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode choiceNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)

Create an immutable choice node.

Parameters:

name - Node identifier

Returns:

A choice node

listNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode listNode(org.opendaylight.yangtools.yang.common.QName name)

Create an immutable list node.

Parameters:

name - QName which will be used as node identifier

Returns:

An unkeyed list node

listNode

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode listNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier name)

Create an immutable list node.

Parameters:

name - Node identifier

Returns:

An unkeyed list node

fromInstanceId

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> fromInstanceId(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx,
                                                                                                          org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id)

Convert YangInstanceIdentifier into a normalized node structure.

Parameters:

ctx - schema context to used during serialization

id - instance identifier to convert to node structure starting from root

Returns:

serialized normalized node for provided instance Id

fromInstanceId

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> fromInstanceId(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx,
                                                                                                          org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id,
                                                                                                          org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> deepestElement)

Convert YangInstanceIdentifier into a normalized node structure.

Parameters:

ctx - schema context to used during serialization

id - instance identifier to convert to node structure starting from root

deepestElement - pre-built deepest child that will be inserted at the last path argument of provided instance identifier

Returns:

serialized normalized node for provided instance Id with overridden last child.

fromInstanceId

public static @NonNull org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> fromInstanceId(org.opendaylight.yangtools.yang.model.api.SchemaContext ctx,
                                                                                                          org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier id,
                                                                                                          Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> deepestElement)

Convert YangInstanceIdentifier into a normalized node structure.

Parameters:

ctx - schema context to used during serialization

id - instance identifier to convert to node structure starting from root

deepestElement - pre-built deepest child that will be inserted at the last path argument of provided instance identifier

Returns:

serialized normalized node for provided instance Id with (optionally) overridden last child and (optionally) marked with specific operation attribute.