org.onosproject.yang.model

Class NodeKey<E extends NodeKey>

java.lang.Object

org.onosproject.yang.model.NodeKey<E>

All Implemented Interfaces:

Cloneable, Comparable<E>

Direct Known Subclasses:

LeafListKey, ListKey

public class NodeKey<E extends NodeKey>
extends Object
implements Comparable<E>, Cloneable

Abstraction of an entity which identifies a node uniquely among its siblings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeKey.NodeKeyBuilder<B extends NodeKey.NodeKeyBuilder<B>> Builder for node key.

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaId	schemaId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodeKey(NodeKey.NodeKeyBuilder builder) Create object from builder.

Method Summary

Modifier and Type	Method and Description
static NodeKey.NodeKeyBuilder	builder() Returns node key builder.
NodeKey	clone() Creates and returns a deep copy of this object.
int	compareTo(NodeKey o)
boolean	equals(Object obj)
int	hashCode()
SchemaId	schemaId() Returns the schema identifier as minimal key required to identify a branching node.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

schemaId

protected SchemaId schemaId

Constructor Detail

NodeKey

protected NodeKey(NodeKey.NodeKeyBuilder builder)

Create object from builder.

Parameters:

builder - initialized builder

Method Detail

builder

public static NodeKey.NodeKeyBuilder builder()

Returns node key builder.

Returns:

node key builder

schemaId

public SchemaId schemaId()

Returns the schema identifier as minimal key required to identify a branching node.

Returns:

schema identifier of a key

compareTo

public int compareTo(NodeKey o)

Specified by:

compareTo in interface Comparable<E extends NodeKey>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public NodeKey clone()
              throws CloneNotSupportedException

Creates and returns a deep copy of this object.

Overrides:

clone in class Object

Returns:

cloned copy

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface