org.onosproject.yang.model

Class ResourceId

java.lang.Object

org.onosproject.yang.model.ResourceId

public final class ResourceId
extends Object

Representation of an entity which identifies a resource in the logical tree data store. It is a list of node keys to identify the branch point hierarchy to reach a resource in the instance tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceId.Builder Builder to construct resource identifier.

Constructor Summary

Constructors

Constructor and Description
ResourceId(ResourceId.Builder builder) Create object from builder.

Method Summary

Modifier and Type	Method and Description
static ResourceId.Builder	builder() Retrieves a new resource builder.
ResourceId.Builder	copyBuilder() Returns resource identifier builder for a given resource identifier.
boolean	equals(Object obj)
int	hashCode()
List<NodeKey>	nodeKeys() Returns the list of node key used to uniquely identify the branch in the logical tree starting from root.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceId

public ResourceId(ResourceId.Builder builder)

Create object from builder.

Parameters:

builder - initialized builder

Method Detail

builder

public static ResourceId.Builder builder()

Retrieves a new resource builder.

Returns:

resource builder

nodeKeys

public List<NodeKey> nodeKeys()

Returns the list of node key used to uniquely identify the branch in the logical tree starting from root.

Returns:

node key uniquely identifying the branch

copyBuilder

public ResourceId.Builder copyBuilder()
                               throws CloneNotSupportedException

Returns resource identifier builder for a given resource identifier. It contains all the attributes from the resource identifier. It is to provide mutability of resource identifier using builder pattern.

Returns:

data node builder

Throws:

CloneNotSupportedException - when clone is not supported

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