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

Interface YangInstanceIdentifier.PathArgument

All Superinterfaces:

Comparable<YangInstanceIdentifier.PathArgument>, Immutable, Serializable

All Known Implementing Classes:

MountPointIdentifier, YangInstanceIdentifier.AugmentationIdentifier, YangInstanceIdentifier.NodeIdentifier, YangInstanceIdentifier.NodeIdentifierWithPredicates, YangInstanceIdentifier.NodeIdentifierWithPredicates.Singleton, YangInstanceIdentifier.NodeWithValue

Enclosing class:

YangInstanceIdentifier

public static interface YangInstanceIdentifier.PathArgument
extends Comparable<YangInstanceIdentifier.PathArgument>, Immutable, Serializable

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.AugmentationIdentifier - Identifier of augmentation
• YangInstanceIdentifier.NodeWithValue - Identifier of leaf-list entry

Method Summary

Modifier and Type	Method	Description
@NonNull QName	getNodeType()	Returns unique QName of data node as defined in YANG Schema, if available.
@NonNull String	toRelativeString(YangInstanceIdentifier.PathArgument previous)	Return the string representation of this object for use in context provided by a previous object.

Methods inherited from interface java.lang.Comparable

compareTo

Method Details

getNodeType

@NonNull QName getNodeType()

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

Returns:

Node type

Throws:

UnsupportedOperationException - if node type is not applicable, for example in case of an augmentation.

toRelativeString

@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 YangInstanceIdentifier.toString(), but implementations are encourage to reuse any context already emitted by the previous object.

Parameters:

previous - Previous path argument

Returns:

String representation