Package org.opendaylight.yangtools.concepts

Class AbstractHierarchicalIdentifier<T extends AbstractHierarchicalIdentifier<T,I>,I>

java.lang.Object

org.opendaylight.yangtools.concepts.AbstractHierarchicalIdentifier<T,I>

All Implemented Interfaces:

Serializable, HierarchicalIdentifier<T>, Identifier, Immutable

Direct Known Subclasses:

YangInstanceIdentifier

public abstract class AbstractHierarchicalIdentifier<T extends AbstractHierarchicalIdentifier<T,I>,I>
extends Object
implements HierarchicalIdentifier<T>

An opinionated superclass for implementing HierarchicalIdentifiers.

It assumes that the identifier is composed of multiple non-null steps available via itemIterator() and that contains(AbstractHierarchicalIdentifier) semantics can be implemented using simple in-order comparison of these steps.

Furthermore it mandates that serialization occurs via writeReplace(), following the Serialization Proxy pattern.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractHierarchicalIdentifier()

Method Summary

Modifier and Type	Method	Description
final boolean	contains(T other)	Check if this identifier contains some other identifier.
abstract boolean	equals(Object obj)
abstract int	hashCode()
protected abstract @NonNull Iterator<@NonNull I>	itemIterator()
protected final void	throwNSE()	Utility method throwing a NotSerializableException.
abstract String	toString()
protected abstract @NonNull Object	writeReplace()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractHierarchicalIdentifier

public AbstractHierarchicalIdentifier()

Method Details

contains

public final boolean contains(T other)

Description copied from interface: HierarchicalIdentifier

Check if this identifier contains some other identifier. If we take HierarchicalIdentifier to be similar to a Path, this is method is the equivalent of other.startsWith(this).

Specified by:

contains in interface HierarchicalIdentifier<T extends AbstractHierarchicalIdentifier<T,I>>

Parameters:

other - Other identifier, may not be null

Returns:

True if this identifier contains the other identifier

itemIterator

protected abstract @NonNull Iterator<@NonNull I> itemIterator()

writeReplace

protected abstract @NonNull Object writeReplace()
                                         throws ObjectStreamException

Throws:

ObjectStreamException

throwNSE

protected final void throwNSE()
                       throws NotSerializableException

Utility method throwing a NotSerializableException. It is useful when implementing readObject(ObjectInputStream), readObjectNoData() and writeObject(ObjectOutputStream) methods, which all subclasses should define as serialization is driven via writeReplace().

Throws:

NotSerializableException - always

hashCode

public abstract int hashCode()

Specified by:

hashCode in interface Identifier

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object obj)

Specified by:

equals in interface Identifier

Overrides:

equals in class Object

toString

public abstract String toString()

Specified by:

toString in interface Identifier

Overrides:

toString in class Object