YangInstanceIdentifier (yangtools 3.0.0-SNAPSHOT API)

java.lang.Object
- org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier

All Implemented Interfaces:

Serializable, Immutable, MutationBehaviour<Immutable>, Path<YangInstanceIdentifier>
```
public abstract class YangInstanceIdentifier
extends Object
implements Path<YangInstanceIdentifier>, Immutable, Serializable
```
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 it's evaluation does not require 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 and Description
`static class`	`YangInstanceIdentifier.AugmentationIdentifier` Composite path argument identifying a `AugmentationNode` node in particular subtree.
`static interface`	`YangInstanceIdentifier.InstanceIdentifierBuilder` Fluent Builder of Instance Identifier instances.
`static 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 class`	`YangInstanceIdentifier.NodeWithValue<T>` Simple path argument identifying a `LeafSetEntryNode` leaf overall data tree.
`static interface`	`YangInstanceIdentifier.PathArgument` Path argument / component of InstanceIdentifier.

Field Summary

Fields
Modifier and Type Field and Description

static YangInstanceIdentifier EMPTY
An empty YangInstanceIdentifier.

Fields
Modifier and Type	Field and Description
`static YangInstanceIdentifier`	`EMPTY` An empty `YangInstanceIdentifier`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static YangInstanceIdentifier.InstanceIdentifierBuilder`	`builder()` Returns new builder for InstanceIdentifier with empty path arguments.
`static YangInstanceIdentifier.InstanceIdentifierBuilder`	`builder(YangInstanceIdentifier origin)` Returns new builder for InstanceIdentifier with path arguments copied from original instance identifier.
`boolean`	`contains(YangInstanceIdentifier other)` Check if this path contains some other.
`static YangInstanceIdentifier`	`create(Iterable<? extends YangInstanceIdentifier.PathArgument> path)`
`static YangInstanceIdentifier`	`create(YangInstanceIdentifier.PathArgument... path)`
`boolean`	`equals(Object obj)`
`abstract YangInstanceIdentifier`	`getAncestor(int depth)` Return the ancestor `YangInstanceIdentifier` with a particular depth, e.g.
`abstract YangInstanceIdentifier.PathArgument`	`getLastPathArgument()` Returns the last PathArgument.
`abstract YangInstanceIdentifier`	`getParent()` Return the conceptual parent `YangInstanceIdentifier`, which has one item less in `getPathArguments()`.
`abstract List<YangInstanceIdentifier.PathArgument>`	`getPathArguments()` Returns an ordered iteration of path arguments.
`abstract List<YangInstanceIdentifier.PathArgument>`	`getReversePathArguments()` Returns an iterable of path arguments in reverse order.
`int`	`hashCode()`
`abstract boolean`	`isEmpty()` Check if this instance identifier has empty path arguments, e.g.
`YangInstanceIdentifier`	`node(QName name)` Constructs a new Instance Identifier with new `YangInstanceIdentifier.NodeIdentifier` added to the end of path arguments.
`YangInstanceIdentifier`	`node(YangInstanceIdentifier.PathArgument arg)` Constructs a new Instance Identifier with new `YangInstanceIdentifier.PathArgument` added to the end of path arguments.
`static 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 YangInstanceIdentifier`	`toOptimized()` Return an optimized version of this identifier, useful when the identifier will be used very frequently.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final YangInstanceIdentifier EMPTY
```
    An empty YangInstanceIdentifier. It corresponds to the path of the conceptual root of the YANG namespace.
- Method Detail
  - 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
```
@Beta
public abstract YangInstanceIdentifier toOptimized()
```
    Return an optimized version of this identifier, useful when the identifier will be used very frequently.
    
    Returns:
    
    A optimized equivalent instance.
  - getParent
```
@Nullable
public abstract YangInstanceIdentifier getParent()
```
    Return the conceptual parent YangInstanceIdentifier, which has one item less in getPathArguments().
    
    Returns:
    
    Parent YangInstanceIdentifier, or null if this object is EMPTY.
  - getAncestor
```
@Nonnull
public abstract 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 List<YangInstanceIdentifier.PathArgument> getPathArguments()
```
    Returns an ordered iteration of path arguments.
    
    Returns:
    
    Immutable iteration of path arguments.
  - getReversePathArguments
```
public abstract 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 YangInstanceIdentifier create(Iterable<? extends YangInstanceIdentifier.PathArgument> path)
```
  - create
```
public static YangInstanceIdentifier create(YangInstanceIdentifier.PathArgument... path)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - node
```
public final 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 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(@Nonnull
                              YangInstanceIdentifier other)
```
    Description copied from interface: Path
    
    Check if this path contains some other.
    
    Specified by:
    
    contains in interface Path<YangInstanceIdentifier>
    
    Parameters:
    
    other - Other path, may not be null.
    
    Returns:
    
    True if this path contains the other.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - of
```
public static 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 YangInstanceIdentifier.InstanceIdentifierBuilder builder()
```
    Returns new builder for InstanceIdentifier with empty path arguments.
    
    Returns:
    
    new builder for InstanceIdentifier with empty path arguments.
  - builder
```
public static 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.

Class YangInstanceIdentifier

Path Arguments

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

Method Detail

isEmpty

toOptimized

getParent

getAncestor

getPathArguments

getReversePathArguments

getLastPathArgument

create

create

equals

node

node

relativeTo

contains

toString

hashCode

of

builder

builder