org.opendaylight.yangtools.yang.data.api

Class YangInstanceIdentifier.AugmentationIdentifier

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing class:

YangInstanceIdentifier

public static final class YangInstanceIdentifier.AugmentationIdentifier
extends Object
implements YangInstanceIdentifier.PathArgument

Composite path argument identifying a AugmentationNode node in particular subtree.

Augmentation is uniquely identified by set of all possible child nodes. This is possible to identify instance of augmentation, since RFC6020 states that augment that augment statement must not add multiple nodes from same namespace / module to the target node.

See Also:

RFC6020, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AugmentationIdentifier(Set<QName> childNames) Construct new augmentation identifier using supplied set of possible child nodes.

Method Summary

Modifier and Type	Method and Description
int	compareTo(YangInstanceIdentifier.PathArgument o)
boolean	equals(Object obj)
QName	getNodeType() If applicable returns unique QName of data node as defined in YANG Schema.
Set<QName>	getPossibleChildNames() Returns set of all possible child nodes.
int	hashCode()
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 Detail

AugmentationIdentifier

public AugmentationIdentifier(Set<QName> childNames)

Construct new augmentation identifier using supplied set of possible child nodes.

Parameters:

childNames - Set of possible child nodes.

Method Detail

getNodeType

public QName getNodeType()

Description copied from interface: YangInstanceIdentifier.PathArgument

If applicable returns unique QName of data node as defined in YANG Schema.

This method may return null, if the corresponding schema node, does not have QName associated, such as in cases of augmentations.

Specified by:

getNodeType in interface YangInstanceIdentifier.PathArgument

Returns:

Node type

getPossibleChildNames

public Set<QName> getPossibleChildNames()

Returns set of all possible child nodes.

Returns:

set of all possible child nodes.

toString

public String toString()

Overrides:

toString in class Object

toRelativeString

public String toRelativeString(YangInstanceIdentifier.PathArgument previous)

Description copied from interface: YangInstanceIdentifier.PathArgument

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.

Specified by:

toRelativeString in interface YangInstanceIdentifier.PathArgument

Parameters:

previous - Previous path argument

Returns:

String representation

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(@Nonnull
                     YangInstanceIdentifier.PathArgument o)

Specified by:

compareTo in interface Comparable<YangInstanceIdentifier.PathArgument>