org.onosproject.net.pi.runtime

Class PiHandle<E extends PiEntity>

java.lang.Object

org.onosproject.net.pi.runtime.PiHandle<E>

Direct Known Subclasses:

PiActionGroupHandle, PiTableEntryHandle

@Beta
public abstract class PiHandle<E extends PiEntity>
extends java.lang.Object

Global identifier of a PI entity applied to a device, unique in the scope of the whole network.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PiHandle(DeviceId deviceId, E piEntity)

Method Summary

Modifier and Type	Method and Description
DeviceId	deviceId() Returns the device ID of this handle.
PiEntityType	entityType() Returns the type of entity identified by this handle.
abstract boolean	equals(java.lang.Object obj)
abstract int	hashCode()
E	piEntity() The entity to which this handle is associated.
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PiHandle

protected PiHandle(DeviceId deviceId,
                   E piEntity)

Method Detail

deviceId

public final DeviceId deviceId()

Returns the device ID of this handle.

Returns:

device ID

entityType

public final PiEntityType entityType()

Returns the type of entity identified by this handle.

Returns:

PI entity type

piEntity

public final E piEntity()

The entity to which this handle is associated.

Returns:

PI entity

hashCode

public abstract int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public abstract boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object