org.onosproject.net.newresource

Class ResourcePath

java.lang.Object

org.onosproject.net.newresource.ResourcePath

@Beta
public final class ResourcePath
extends Object

An object that is used to locate a resource in a network. A ResourcePath represents a path that is hierarchical and composed of a sequence of elementary resources that are not globally identifiable. A ResourcePath can be a globally unique resource identifier. Users of this class must keep the semantics of resources regarding the hierarchical structure. For example, resource path, Link:1/VLAN ID:100, is valid, but resource path, VLAN ID:100/Link:1 is not valid because a link is not a sub-component of a VLAN ID.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourcePath	ROOT

Constructor Summary

Constructors

Constructor and Description
ResourcePath(List<Object> components) Creates an resource path from the specified components.
ResourcePath(Object... components) Creates an resource path from the specified components.

Method Summary

Modifier and Type	Method and Description
static ResourcePath	child(ResourcePath parent, Object child)
List<Object>	components() Returns the components of this resource path.
boolean	equals(Object obj)
int	hashCode()
boolean	isRoot() Returns true if the path represents root.
Object	lastComponent() Returns the last component of this instance.
Optional<ResourcePath>	parent() Returns the parent resource path of this instance.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final ResourcePath ROOT

Constructor Detail

ResourcePath

public ResourcePath(Object... components)

Creates an resource path from the specified components.

Parameters:

components - components of the path. The order represents hierarchical structure of the resource.

ResourcePath

public ResourcePath(List<Object> components)

Creates an resource path from the specified components.

Parameters:

components - components of the path. The order represents hierarchical structure of the resource.

Method Detail

child

public static ResourcePath child(ResourcePath parent,
                                 Object child)

components

public List<Object> components()

Returns the components of this resource path.

Returns:

the components of this resource path

parent

public Optional<ResourcePath> parent()

Returns the parent resource path of this instance. E.g. if this path is Link:1/VLAN ID:100, the return value is the resource path for Link:1.

Returns:

the parent resource path of this instance. If there is no parent, empty instance will be returned.

isRoot

public boolean isRoot()

Returns true if the path represents root.

Returns:

true if the path represents root, false otherwise.

lastComponent

public Object lastComponent()

Returns the last component of this instance.

Returns:

the last component of this instance. The return value is equal to the last object of components().

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