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

Class YangInstanceIdentifier

java.lang.Object

org.opendaylight.yangtools.concepts.AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

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

All Implemented Interfaces:

Serializable, HierarchicalIdentifier<YangInstanceIdentifier>, Identifier, Immutable

public abstract sealed class YangInstanceIdentifier
extends AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

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

See Also:

• RFC6020
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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 class	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().
static @NonNull YangInstanceIdentifier	create(Iterable<? extends YangInstanceIdentifier.PathArgument> path)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(Iterable) instead.
static @NonNull YangInstanceIdentifier	create(YangInstanceIdentifier.PathArgument pathArgument)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(NodeIdentifier) instead.
static @NonNull YangInstanceIdentifier	create(YangInstanceIdentifier.PathArgument... path)	Deprecated, for removal: This API element is subject to removal in a future version. Use of(PathArgument...) instead.
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 final @NonNull YangInstanceIdentifier	empty()	Deprecated, for removal: This API element is subject to removal in a future version. Use of() instead.
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.
protected final Iterator<YangInstanceIdentifier.PathArgument>	itemIterator()
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 final @NonNull YangInstanceIdentifier	of()	Return an empty YangInstanceIdentifier.
static final @NonNull YangInstanceIdentifier	of(ImmutableList<YangInstanceIdentifier.PathArgument> path)	Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.
static final @NonNull YangInstanceIdentifier	of(Iterable<? extends YangInstanceIdentifier.PathArgument> path)	Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.
static final @NonNull YangInstanceIdentifier	of(Collection<? extends YangInstanceIdentifier.PathArgument> path)	Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.
static final @NonNull YangInstanceIdentifier	of(QName name)	Returns a new YangInstanceIdentifier with only one path argument of type YangInstanceIdentifier.NodeIdentifier with supplied QName.
static final @NonNull YangInstanceIdentifier	of(QName... path)	Returns a new YangInstanceIdentifier with path arguments of type YangInstanceIdentifier.NodeIdentifier with supplied QNames.
static final @NonNull YangInstanceIdentifier	of(YangInstanceIdentifier.PathArgument name)	Returns a new InstanceIdentifier with only one path argument of type YangInstanceIdentifier.PathArgument.
static final @NonNull YangInstanceIdentifier	of(YangInstanceIdentifier.PathArgument... path)	Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.
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()
protected final Object	writeReplace()

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

contains, throwNSE

Methods inherited from class java.lang.Object

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

Method Details

empty

@Deprecated(since="11.0.0",
            forRemoval=true)
public static final @NonNull YangInstanceIdentifier empty()

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

Use of() instead.

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

Returns:

An empty YangInstanceIdentifier

of

public static final @NonNull YangInstanceIdentifier of()

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

Returns:

An empty YangInstanceIdentifier

of

public static final @NonNull YangInstanceIdentifier of(YangInstanceIdentifier.PathArgument name)

Returns a new InstanceIdentifier with only one path argument of type YangInstanceIdentifier.PathArgument.

Parameters:

name - QName of first node identifier

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if name is null

of

public static final @NonNull YangInstanceIdentifier of(YangInstanceIdentifier.PathArgument... path)

Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.

Parameters:

path - Path arguments

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path or any of its components is null

of

public static final @NonNull YangInstanceIdentifier of(ImmutableList<YangInstanceIdentifier.PathArgument> path)

Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.

Parameters:

path - Path arguments

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path is null

of

public static final @NonNull YangInstanceIdentifier of(Collection<? extends YangInstanceIdentifier.PathArgument> path)

Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.

Parameters:

path - Path arguments

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path or any of its components is null

of

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

Returns a new InstanceIdentifier composed of supplied YangInstanceIdentifier.PathArguments.

Parameters:

path - Path arguments

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path or any of its components is null

of

public static final @NonNull YangInstanceIdentifier of(QName name)

Returns a new YangInstanceIdentifier with only one path argument of type YangInstanceIdentifier.NodeIdentifier with supplied QName. Note this is a convenience method aimed at test code. Production code should consider using of(PathArgument) instead.

Parameters:

name - QName of first YangInstanceIdentifier.NodeIdentifier

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if name is null

of

public static final @NonNull YangInstanceIdentifier of(QName... path)

Returns a new YangInstanceIdentifier with path arguments of type YangInstanceIdentifier.NodeIdentifier with supplied QNames. Note this is a convenience method aimed at test code. Production code should consider using of(PathArgument...) instead.

Parameters:

path - QNames of YangInstanceIdentifier.NodeIdentifiers

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path or any of its components is null

create

@Deprecated(since="11.0.0",
            forRemoval=true)
public static @NonNull YangInstanceIdentifier create(YangInstanceIdentifier.PathArgument pathArgument)

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

Use of(NodeIdentifier) instead.

Create a YangInstanceIdentifier composed of a single YangInstanceIdentifier.PathArgument.

Parameters:

pathArgument - Path argument

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if pathArgument is null

create

@Deprecated(since="11.0.0",
            forRemoval=true)
public static @NonNull YangInstanceIdentifier create(YangInstanceIdentifier.PathArgument... path)

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

Use of(PathArgument...) instead.

Create a YangInstanceIdentifier composed of specified YangInstanceIdentifier.PathArguments.

Parameters:

path - Path arguments

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path or any of its components is null

create

@Deprecated(since="11.0.0",
            forRemoval=true)
public static @NonNull YangInstanceIdentifier create(Iterable<? extends YangInstanceIdentifier.PathArgument> path)

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

Use of(Iterable) instead.

Create a YangInstanceIdentifier composed of specified YangInstanceIdentifier.PathArguments.

Parameters:

path - Path arguments

Returns:

A YangInstanceIdentifier

Throws:

NullPointerException - if path or any of its components is null

isEmpty

public abstract boolean isEmpty()

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

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 of().

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 of().

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.

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

Specified by:

equals in class AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

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.

itemIterator

protected final Iterator<YangInstanceIdentifier.PathArgument> itemIterator()

Specified by:

itemIterator in class AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

writeReplace

protected final Object writeReplace()

Specified by:

writeReplace in class AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

toString

public final String toString()

Specified by:

toString in interface Identifier

Specified by:

toString in class AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

hashCode

public final int hashCode()

Specified by:

hashCode in interface Identifier

Specified by:

hashCode in class AbstractHierarchicalIdentifier<YangInstanceIdentifier,YangInstanceIdentifier.PathArgument>

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.