Package org.opendaylight.yangtools.yang.data.util

Class DataSchemaContextNode<T extends YangInstanceIdentifier.PathArgument>

java.lang.Object

org.opendaylight.yangtools.concepts.AbstractIdentifiable<T,T>

org.opendaylight.yangtools.concepts.AbstractSimpleIdentifiable<T>

org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode<T>

Type Parameters:

T - Path Argument type

All Implemented Interfaces:

Identifiable<T>

public abstract class DataSchemaContextNode<T extends YangInstanceIdentifier.PathArgument>
extends AbstractSimpleIdentifiable<T>

Schema derived data providing necessary information for mapping between NormalizedNode and serialization format defined in RFC6020, since the mapping is not one-to-one.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataSchemaContextNode(T identifier, SchemaNode schema)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static YangInstanceIdentifier.AugmentationIdentifier	augmentationIdentifierFrom(AugmentationSchemaNode schema)	Create AugmentationIdentifier from an AugmentationSchemaNode.
protected abstract @Nullable DataSchemaContextNode<?>	enterChild(@NonNull QName child, @NonNull SchemaInferenceStack stack)
protected abstract @Nullable DataSchemaContextNode<?>	enterChild(@NonNull YangInstanceIdentifier.PathArgument child, @NonNull SchemaInferenceStack stack)
final @Nullable DataSchemaContextNode<?>	enterChild(SchemaInferenceStack stack, QName child)	Attempt to enter a child DataSchemaContextNode towards the DataSchemaNode child identified by specified data tree QName, adjusting provided stack with inference steps corresponding to the transition to the returned node.
final @Nullable DataSchemaContextNode<?>	enterChild(SchemaInferenceStack stack, YangInstanceIdentifier.PathArgument child)	Attempt to enter a child DataSchemaContextNode towards the DataSchemaNode child identified by specified YangInstanceIdentifier.PathArgument, adjusting provided stack with inference steps corresponding to the transition to the returned node.
final @NonNull Optional<@NonNull DataSchemaContextNode<?>>	findChild(@NonNull YangInstanceIdentifier path)	Find a child node as identified by a YangInstanceIdentifier relative to this node.
static @NonNull DataSchemaContextNode<?>	from(EffectiveModelContext ctx)	Deprecated, for removal: This API element is subject to removal in a future version. Use DataSchemaContextTree.from(EffectiveModelContext) and DataSchemaContextTree.getRoot() instead.
static @Nullable DataSchemaContextNode<?>	fromDataSchemaNode(DataSchemaNode potential)	Deprecated, for removal: This API element is subject to removal in a future version.
abstract @Nullable DataSchemaContextNode<?>	getChild(QName child)	Find a child node identifier by its {code data tree} QName.
abstract @Nullable DataSchemaContextNode<?>	getChild(YangInstanceIdentifier.PathArgument child)	Find a child node identifier by its YangInstanceIdentifier.PathArgument.
@Nullable DataSchemaNode	getDataSchemaNode()
protected Set<QName>	getQNameIdentifiers()
boolean	isKeyedEntry()
abstract boolean	isLeaf()
boolean	isMixin()	This node is a NormalizedNode intermediate, not represented in RFC7950 XML encoding.
protected void	pushToStack(@NonNull SchemaInferenceStack stack)	Push this node into specified SchemaInferenceStack.

Methods inherited from class org.opendaylight.yangtools.concepts.AbstractIdentifiable

addToStringAttributes, getIdentifier, toString

Methods inherited from class java.lang.Object

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

Constructor Details

DataSchemaContextNode

@Deprecated(forRemoval=true,
            since="8.0.2")
protected DataSchemaContextNode(T identifier,
 SchemaNode schema)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

isMixin

public boolean isMixin()

This node is a NormalizedNode intermediate, not represented in RFC7950 XML encoding. This is typically one of

• AugmentationNode backed by an AugmentationSchemaNode, or
• ChoiceNode backed by a ChoiceSchemaNode, or
• LeafSetNode backed by a LeafListSchemaNode, or
• MapNode backed by a ListSchemaNode with a non-empty ListSchemaNode.getKeyDefinition(), or
• UnkeyedListNode backed by a ListSchemaNode with an empty ListSchemaNode.getKeyDefinition()

Returns:

false if this node corresponds to an XML element, or true if it is an encapsulation node.

isKeyedEntry

public boolean isKeyedEntry()

isLeaf

public abstract boolean isLeaf()

getQNameIdentifiers

protected Set<QName> getQNameIdentifiers()

getChild

public abstract @Nullable DataSchemaContextNode<?> getChild(YangInstanceIdentifier.PathArgument child)

Find a child node identifier by its YangInstanceIdentifier.PathArgument.

Parameters:

child - Child path argument

Returns:

A child node, or null if not found

getChild

public abstract @Nullable DataSchemaContextNode<?> getChild(QName child)

Find a child node identifier by its {code data tree} QName. This method returns intermediate nodes significant from YangInstanceIdentifier hierarchy of YangInstanceIdentifier.PathArguments. If the returned node indicates true via isMixin(), it represents a NormalizedNode encapsulation which is not visible in RFC7950 XML encoding, and a further call to this method with the same child argument will provide the next step.

Parameters:

child - Child data tree QName

Returns:

A child node, or null if not found

enterChild

public final @Nullable DataSchemaContextNode<?> enterChild(SchemaInferenceStack stack,
 QName child)

Attempt to enter a child DataSchemaContextNode towards the DataSchemaNode child identified by specified data tree QName, adjusting provided stack with inference steps corresponding to the transition to the returned node. The stack is expected to be correctly pointing at this node's schema, otherwise the results of this method are undefined.

Parameters:

stack - SchemaInferenceStack to update

child - Child QName

Returns:

A DataSchemaContextNode on the path towards the specified child

Throws:

NullPointerException - if any argument is null

enterChild

protected abstract @Nullable DataSchemaContextNode<?> enterChild(@NonNull QName child,
 @NonNull SchemaInferenceStack stack)

enterChild

public final @Nullable DataSchemaContextNode<?> enterChild(SchemaInferenceStack stack,
 YangInstanceIdentifier.PathArgument child)

Attempt to enter a child DataSchemaContextNode towards the DataSchemaNode child identified by specified YangInstanceIdentifier.PathArgument, adjusting provided stack with inference steps corresponding to the transition to the returned node. The stack is expected to be correctly pointing at this node's schema, otherwise the results of this method are undefined.

Parameters:

stack - SchemaInferenceStack to update

child - Child path argument

Returns:

A DataSchemaContextNode for the specified child

Throws:

NullPointerException - if any argument is null

enterChild

protected abstract @Nullable DataSchemaContextNode<?> enterChild(@NonNull YangInstanceIdentifier.PathArgument child,
 @NonNull SchemaInferenceStack stack)

pushToStack

protected void pushToStack(@NonNull SchemaInferenceStack stack)

Push this node into specified SchemaInferenceStack.

Parameters:

stack - SchemaInferenceStack

getDataSchemaNode

public @Nullable DataSchemaNode getDataSchemaNode()

findChild

public final @NonNull Optional<@NonNull DataSchemaContextNode<?>> findChild(@NonNull YangInstanceIdentifier path)

Find a child node as identified by a YangInstanceIdentifier relative to this node.

Parameters:

path - Path towards the child node

Returns:

Child node if present, or empty when corresponding child is not found.

Throws:

NullPointerException - if path is null

augmentationIdentifierFrom

public static YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifierFrom(AugmentationSchemaNode schema)

Create AugmentationIdentifier from an AugmentationSchemaNode.

Parameters:

schema - Augmentation schema

Returns:

AugmentationIdentifier for the schema

Throws:

NullPointerException - if schema is null

fromDataSchemaNode

@Deprecated(forRemoval=true,
            since="8.0.2")
public static @Nullable DataSchemaContextNode<?> fromDataSchemaNode(DataSchemaNode potential)

Deprecated, for removal: This API element is subject to removal in a future version.

Get a DataSchemaContextNode for a particular DataSchemaNode.

Parameters:

potential - Backing DataSchemaNode

Returns:

A DataSchemaContextNode, or null if the input is null or of unhandled type

from

@Deprecated(forRemoval=true,
            since="8.0.2")
public static @NonNull DataSchemaContextNode<?> from(EffectiveModelContext ctx)

Deprecated, for removal: This API element is subject to removal in a future version.

Use DataSchemaContextTree.from(EffectiveModelContext) and DataSchemaContextTree.getRoot() instead.

Return a DataSchemaContextNode corresponding to specified EffectiveModelContext.

Parameters:

ctx - EffectiveModelContext

Returns:

A DataSchemaContextNode

Throws:

NullPointerException - if ctx is null