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

Class YangInstanceIdentifier

java.lang.Object

org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier

All Implemented Interfaces:

Serializable, HierarchicalIdentifier<YangInstanceIdentifier>, Identifier, Immutable

public abstract sealed class YangInstanceIdentifier
extends Object
implements HierarchicalIdentifier<YangInstanceIdentifier>

Unique identifier of a particular node instance in the data tree.

Java representation of YANG Built-in type instance-identifier, which conceptually is XPath expression minimized to uniquely identify element in data tree which conforms to constraints maintained by YANG Model, effectively this makes Instance Identifier a path to element in data tree.

Constraints put in YANG specification on instance-identifier allowed it to be effectively represented in Java and its evaluation does not require a full-blown XPath processor.

Path Arguments

Path to the node represented in instance identifier consists of YangInstanceIdentifier.PathArgument which carries necessary information to uniquely identify node on particular level in the subtree.

• YangInstanceIdentifier.NodeIdentifier - Identifier of node, which has cardinality 0..1 in particular subtree in data tree
• YangInstanceIdentifier.NodeIdentifierWithPredicates - Identifier of node (list item), which has cardinality 0..n
• YangInstanceIdentifier.NodeWithValue - Identifier of instance leaf node or leaf-list node
• YangInstanceIdentifier.AugmentationIdentifier - Identifier of instance of augmentation node

See Also:

• RFC6020
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	YangInstanceIdentifier.AugmentationIdentifier	Composite path argument identifying a AugmentationNode node in particular subtree.
static interface	YangInstanceIdentifier.InstanceIdentifierBuilder	Fluent Builder of Instance Identifier instances.
static final class	YangInstanceIdentifier.NodeIdentifier	Simple path argument identifying a ContainerNode or LeafNode leaf in particular subtree.
static class	YangInstanceIdentifier.NodeIdentifierWithPredicates	Composite path argument identifying a MapEntryNode leaf overall data tree.
static final class	YangInstanceIdentifier.NodeWithValue<T>	Simple path argument identifying a LeafSetEntryNode leaf overall data tree.
static interface	YangInstanceIdentifier.PathArgument	Path argument / component of InstanceIdentifier.

Method Summary

Modifier and Type	Method	Description
static @NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	builder()	Returns new builder for InstanceIdentifier with empty path arguments.
static @NonNull YangInstanceIdentifier.InstanceIdentifierBuilder	builder(YangInstanceIdentifier origin)	Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.
abstract @NonNull YangInstanceIdentifier	coerceParent()	Return the conceptual parent YangInstanceIdentifier, which has one item less in getPathArguments().
final boolean	contains(YangInstanceIdentifier other)	Check if this identifier contains some other identifier.
static @NonNull YangInstanceIdentifier	create(Iterable<? extends YangInstanceIdentifier.PathArgument> path)
static @NonNull YangInstanceIdentifier	create(YangInstanceIdentifier.PathArgument pathArgument)
static @NonNull YangInstanceIdentifier	create(YangInstanceIdentifier.PathArgument... path)
static <T> @NonNull YangInstanceIdentifier	createReverse(Deque<? extends T> stackTowardsRoot, Function<T,YangInstanceIdentifier.PathArgument> function)	Create a YangInstanceIdentifier by walking specified stack backwards and extracting path components from it.
static @NonNull YangInstanceIdentifier	createReverse(Deque<YangInstanceIdentifier.PathArgument> pathTowardsRoot)	Create a YangInstanceIdentifier by taking a snapshot of provided path and iterating it backwards.
static @NonNull YangInstanceIdentifier	empty()	Return An empty YangInstanceIdentifier.
final boolean	equals(Object obj)
abstract @NonNull YangInstanceIdentifier	getAncestor(int depth)	Return the ancestor YangInstanceIdentifier with a particular depth, e.g.
abstract YangInstanceIdentifier.PathArgument	getLastPathArgument()	Returns the last PathArgument.
abstract @Nullable YangInstanceIdentifier	getParent()	Return the conceptual parent YangInstanceIdentifier, which has one item less in getPathArguments().
abstract @NonNull List<YangInstanceIdentifier.PathArgument>	getPathArguments()	Returns an ordered iteration of path arguments.
abstract @NonNull List<YangInstanceIdentifier.PathArgument>	getReversePathArguments()	Returns an iterable of path arguments in reverse order.
final int	hashCode()
abstract boolean	isEmpty()	Check if this instance identifier has empty path arguments, e.g.
final @NonNull YangInstanceIdentifier	node(QName name)	Constructs a new Instance Identifier with new YangInstanceIdentifier.NodeIdentifier added to the end of path arguments.
final @NonNull YangInstanceIdentifier	node(YangInstanceIdentifier.PathArgument arg)	Constructs a new Instance Identifier with new YangInstanceIdentifier.PathArgument added to the end of path arguments.
static @NonNull YangInstanceIdentifier	of(QName name)	Returns a new InstanceIdentifier with only one path argument of type YangInstanceIdentifier.NodeIdentifier with supplied QName.
Optional<YangInstanceIdentifier>	relativeTo(YangInstanceIdentifier ancestor)	Get the relative path from an ancestor.
abstract @NonNull YangInstanceIdentifier	toOptimized()	Return an optimized version of this identifier, useful when the identifier will be used very frequently.
final String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

empty

public static @NonNull YangInstanceIdentifier empty()

Return An empty YangInstanceIdentifier. It corresponds to the path of the conceptual root of the YANG namespace.

Returns:

An empty YangInstanceIdentifier

isEmpty

public abstract boolean isEmpty()

Check if this instance identifier has empty path arguments, e.g. it is empty and corresponds to empty().

Returns:

True if this instance identifier is empty, false otherwise.

toOptimized

public abstract @NonNull YangInstanceIdentifier toOptimized()

Return an optimized version of this identifier, useful when the identifier will be used very frequently.

Returns:

A optimized equivalent instance.

getParent

public abstract @Nullable YangInstanceIdentifier getParent()

Return the conceptual parent YangInstanceIdentifier, which has one item less in getPathArguments().

Returns:

Parent YangInstanceIdentifier, or null if this object is empty().

coerceParent

public abstract @NonNull YangInstanceIdentifier coerceParent()

Return the conceptual parent YangInstanceIdentifier, which has one item less in getPathArguments().

Returns:

Parent YangInstanceIdentifier

Throws:

VerifyException - if this object is empty().

getAncestor

public abstract @NonNull YangInstanceIdentifier getAncestor(int depth)

Return the ancestor YangInstanceIdentifier with a particular depth, e.g. number of path arguments.

Parameters:

depth - Ancestor depth

Returns:

Ancestor YangInstanceIdentifier

Throws:

IllegalArgumentException - if the specified depth is negative or is greater than the depth of this object.

getPathArguments

public abstract @NonNull List<YangInstanceIdentifier.PathArgument> getPathArguments()

Returns an ordered iteration of path arguments.

Returns:

Immutable iteration of path arguments.

getReversePathArguments

public abstract @NonNull List<YangInstanceIdentifier.PathArgument> getReversePathArguments()

Returns an iterable of path arguments in reverse order. This is useful when walking up a tree organized this way.

Returns:

Immutable iterable of path arguments in reverse order.

getLastPathArgument

public abstract YangInstanceIdentifier.PathArgument getLastPathArgument()

Returns the last PathArgument. This is equivalent of iterating to the last element of the iterable returned by getPathArguments().

Returns:

The last past argument, or null if there are no PathArguments.

create

public static @NonNull YangInstanceIdentifier create(Iterable<? extends YangInstanceIdentifier.PathArgument> path)

create

public static @NonNull YangInstanceIdentifier create(YangInstanceIdentifier.PathArgument pathArgument)

create

public static @NonNull YangInstanceIdentifier create(YangInstanceIdentifier.PathArgument... path)

createReverse

public static @NonNull YangInstanceIdentifier createReverse(Deque<YangInstanceIdentifier.PathArgument> pathTowardsRoot)

Create a YangInstanceIdentifier by taking a snapshot of provided path and iterating it backwards.

Parameters:

pathTowardsRoot - Path towards root

Returns:

A YangInstanceIdentifier instance

Throws:

NullPointerException - if pathTowardsRoot or any of its members is null

createReverse

public static <T> @NonNull YangInstanceIdentifier createReverse(Deque<? extends T> stackTowardsRoot,
 Function<T,YangInstanceIdentifier.PathArgument> function)

Create a YangInstanceIdentifier by walking specified stack backwards and extracting path components from it.

Parameters:

stackTowardsRoot - Stack towards root,

Returns:

A YangInstanceIdentifier instance

Throws:

NullPointerException - if pathTowardsRoot is null

equals

public final boolean equals(Object obj)

Specified by:

equals in interface Identifier

Overrides:

equals in class Object

node

public final @NonNull YangInstanceIdentifier node(QName name)

Constructs a new Instance Identifier with new YangInstanceIdentifier.NodeIdentifier added to the end of path arguments.

Parameters:

name - QName of YangInstanceIdentifier.NodeIdentifier

Returns:

Instance Identifier with additional path argument added to the end.

node

public final @NonNull YangInstanceIdentifier node(YangInstanceIdentifier.PathArgument arg)

Constructs a new Instance Identifier with new YangInstanceIdentifier.PathArgument added to the end of path arguments.

Parameters:

arg - Path argument which should be added to the end

Returns:

Instance Identifier with additional path argument added to the end.

relativeTo

public Optional<YangInstanceIdentifier> relativeTo(YangInstanceIdentifier ancestor)

Get the relative path from an ancestor. This method attempts to perform the reverse of concatenating a base (ancestor) and a path.

Parameters:

ancestor - Ancestor against which the relative path should be calculated

Returns:

This object's relative path from parent, or Optional.absent() if the specified parent is not in fact an ancestor of this object.

contains

public final boolean contains(YangInstanceIdentifier other)

Description copied from interface: HierarchicalIdentifier

Check if this identifier contains some other identifier. If we take HierarchicalIdentifier to be similar to a Path, this is method is the equivalent of other.startsWith(this).

Specified by:

contains in interface HierarchicalIdentifier<YangInstanceIdentifier>

Parameters:

other - Other identifier, may not be null

Returns:

True if this identifier contains the other identifier

toString

public final String toString()

Specified by:

toString in interface Identifier

Overrides:

toString in class Object

hashCode

public final int hashCode()

Specified by:

hashCode in interface Identifier

Overrides:

hashCode in class Object

of

public static @NonNull YangInstanceIdentifier of(QName name)

Returns a new InstanceIdentifier with only one path argument of type YangInstanceIdentifier.NodeIdentifier with supplied QName.

Parameters:

name - QName of first node identifier

Returns:

Instance Identifier with only one path argument of type YangInstanceIdentifier.NodeIdentifier

builder

public static @NonNull YangInstanceIdentifier.InstanceIdentifierBuilder builder()

Returns new builder for InstanceIdentifier with empty path arguments.

Returns:

new builder for InstanceIdentifier with empty path arguments.

builder

public static @NonNull YangInstanceIdentifier.InstanceIdentifierBuilder builder(YangInstanceIdentifier origin)

Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.

Parameters:

origin - InstanceIdentifier from which path arguments are copied.

Returns:

new builder for InstanceIdentifier with path arguments copied from original instance identifier.