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

Class YangInstanceIdentifier.PathArgument

java.lang.Object

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

All Implemented Interfaces:

Serializable, Comparable<YangInstanceIdentifier.PathArgument>, Identifier, Immutable

Direct Known Subclasses:

YangInstanceIdentifier.NodeIdentifier, YangInstanceIdentifier.NodeIdentifierWithPredicates, YangInstanceIdentifier.NodeWithValue

Enclosing class:

YangInstanceIdentifier

public abstract static sealed class YangInstanceIdentifier.PathArgument
extends Object
implements Identifier, Comparable<YangInstanceIdentifier.PathArgument>
permits YangInstanceIdentifier.NodeIdentifier, YangInstanceIdentifier.NodeWithValue<T>, YangInstanceIdentifier.NodeIdentifierWithPredicates

Path argument / component of InstanceIdentifier. Path argument uniquely identifies node in data tree on particular level.

This interface itself is used as common parent for actual path arguments types and should not be implemented by user code.

Path arguments SHOULD contain only minimum of information required to uniquely identify node on particular subtree level.

For actual path arguments types see:

• YangInstanceIdentifier.NodeIdentifier - Identifier of container or leaf
• YangInstanceIdentifier.NodeIdentifierWithPredicates - Identifier of list entries, which have key defined
• YangInstanceIdentifier.NodeWithValue - Identifier of leaf-list entry

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathArgument(QName nodeType)

Method Summary

Modifier and Type	Method	Description
int	compareTo(YangInstanceIdentifier.PathArgument o)
boolean	equals(Object obj)
final @NonNull QName	getNodeType()	Returns unique QName of data node as defined in YANG Schema, if available.
final int	hashCode()
protected int	hashCodeImpl()
@NonNull String	toRelativeString(YangInstanceIdentifier.PathArgument previous)	Return the string representation of this object for use in context provided by a previous object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PathArgument

protected PathArgument(QName nodeType)

Method Details

getNodeType

public final @NonNull QName getNodeType()

Returns unique QName of data node as defined in YANG Schema, if available.

Returns:

Node type

toRelativeString

public @NonNull String toRelativeString(YangInstanceIdentifier.PathArgument previous)

Return the string representation of this object for use in context provided by a previous object. This method can be implemented in terms of toString(), but implementations are encourage to reuse any context already emitted by the previous object.

Parameters:

previous - Previous path argument

Returns:

String representation

compareTo

public int compareTo(YangInstanceIdentifier.PathArgument o)

Specified by:

compareTo in interface Comparable<YangInstanceIdentifier.PathArgument>

hashCodeImpl

protected int hashCodeImpl()

hashCode

public final int hashCode()

Specified by:

hashCode in interface Identifier

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Identifier

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface Identifier

Overrides:

toString in class Object