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 ChoiceNode	choiceNode(QName name) Create an immutable choice node.
static @NonNull ChoiceNode	choiceNode(YangInstanceIdentifier.NodeIdentifier name) Create an immutable choice node.
static @NonNull ContainerNode	containerNode(QName name) Create an immutable container node.
static @NonNull ContainerNode	containerNode(YangInstanceIdentifier.NodeIdentifier name) Create an immutable container node.
static @NonNull NormalizedNode<?,?>	fromInstanceId(SchemaContext ctx, YangInstanceIdentifier id) Convert YangInstanceIdentifier into a normalized node structure.
static @NonNull NormalizedNode<?,?>	fromInstanceId(SchemaContext ctx, YangInstanceIdentifier id, NormalizedNode<?,?> deepestElement) Convert YangInstanceIdentifier into a normalized node structure.
static @NonNull NormalizedNode<?,?>	fromInstanceId(SchemaContext ctx, YangInstanceIdentifier id, Optional<NormalizedNode<?,?>> deepestElement, Optional<Map.Entry<QName,ModifyAction>> operation) Convert YangInstanceIdentifier into a normalized node structure.
static <T> @NonNull LeafNode<T>	leafNode(QName name, T value) Construct immutable leaf node.
static <T> @NonNull LeafNode<T>	leafNode(YangInstanceIdentifier.NodeIdentifier name, T value) Construct immutable leaf node.
static @NonNull UnkeyedListNode	listNode(QName name) Create an immutable list node.
static @NonNull UnkeyedListNode	listNode(YangInstanceIdentifier.NodeIdentifier name) Create an immutable list node.
static @NonNull MapEntryNode	mapEntry(QName nodeName, QName keyName, Object keyValue)
static @NonNull DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>	mapEntryBuilder()
static @NonNull DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode>	mapEntryBuilder(QName nodeName, QName keyName, Object keyValue)
static @NonNull MapNode	mapNode(QName name) Create an immutable map node.
static @NonNull MapNode	mapNode(YangInstanceIdentifier.NodeIdentifier name) Create an immutable map node.
static @NonNull CollectionNodeBuilder<MapEntryNode,MapNode>	mapNodeBuilder()
static @NonNull CollectionNodeBuilder<MapEntryNode,MapNode>	mapNodeBuilder(QName name)
static @NonNull CollectionNodeBuilder<MapEntryNode,MapNode>	mapNodeBuilder(YangInstanceIdentifier.NodeIdentifier name)
static @NonNull OrderedMapNode	orderedMapNode(QName name) Create immutable ordered map node.
static @NonNull OrderedMapNode	orderedMapNode(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<MapEntryNode,MapNode> mapNodeBuilder()

mapNodeBuilder

public static @NonNull CollectionNodeBuilder<MapEntryNode,MapNode> mapNodeBuilder(QName name)

mapNodeBuilder

public static @NonNull CollectionNodeBuilder<MapEntryNode,MapNode> mapNodeBuilder(YangInstanceIdentifier.NodeIdentifier name)

mapNode

public static @NonNull MapNode mapNode(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 MapNode mapNode(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 OrderedMapNode orderedMapNode(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 OrderedMapNode orderedMapNode(YangInstanceIdentifier.NodeIdentifier name)

Create immutable ordered map node.

Parameters:

name - Node identifier

Returns:

An ordered Map node

leafNode

public static <T> @NonNull LeafNode<T> leafNode(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 LeafNode<T> leafNode(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<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode> mapEntryBuilder(QName nodeName,
                                                                                                                                  QName keyName,
                                                                                                                                  Object keyValue)

mapEntryBuilder

public static @NonNull DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifierWithPredicates,MapEntryNode> mapEntryBuilder()

mapEntry

public static @NonNull MapEntryNode mapEntry(QName nodeName,
                                             QName keyName,
                                             Object keyValue)

containerNode

public static @NonNull ContainerNode containerNode(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 ContainerNode containerNode(YangInstanceIdentifier.NodeIdentifier name)

Create an immutable container node.

Parameters:

name - Node identifier

Returns:

A container node

choiceNode

public static @NonNull ChoiceNode choiceNode(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 ChoiceNode choiceNode(YangInstanceIdentifier.NodeIdentifier name)

Create an immutable choice node.

Parameters:

name - Node identifier

Returns:

A choice node

listNode

public static @NonNull UnkeyedListNode listNode(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 UnkeyedListNode listNode(YangInstanceIdentifier.NodeIdentifier name)

Create an immutable list node.

Parameters:

name - Node identifier

Returns:

An unkeyed list node

fromInstanceId

public static @NonNull NormalizedNode<?,?> fromInstanceId(SchemaContext ctx,
                                                          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 NormalizedNode<?,?> fromInstanceId(SchemaContext ctx,
                                                          YangInstanceIdentifier id,
                                                          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 NormalizedNode<?,?> fromInstanceId(SchemaContext ctx,
                                                          YangInstanceIdentifier id,
                                                          Optional<NormalizedNode<?,?>> deepestElement,
                                                          Optional<Map.Entry<QName,ModifyAction>> operation)

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

operation - modify operation attribute to be added to the deepest child. QName is the operation attribute key and ModifyAction is the value.

Returns:

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