Package org.onosproject.net.device

Enum DeviceAgentEvent.Type

java.lang.Object

java.lang.Enum<DeviceAgentEvent.Type>

org.onosproject.net.device.DeviceAgentEvent.Type

All Implemented Interfaces:

Serializable, Comparable<DeviceAgentEvent.Type>

Enclosing class:

DeviceAgentEvent

public static enum DeviceAgentEvent.Type
extends Enum<DeviceAgentEvent.Type>

Type of device events.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANNEL_CLOSED	Signifies that a channel between the agent and the device is closed and the two cannot communicate.
CHANNEL_ERROR	Signifies that a channel error has been detected.
CHANNEL_OPEN	Signifies that a channel between the agent and the device is open and the two can communicate.
NOT_MASTER	Signifies that the agent tried to perform some operations on the device that requires master role.
ROLE_MASTER	Signifies that the agent has acquired master role.
ROLE_NONE	Signifies that the agent doesn't have any valid mastership role for the device.
ROLE_STANDBY	Signifies that the agent has acquired standby/slave mastership role.

Method Summary

Modifier and Type	Method	Description
static DeviceAgentEvent.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DeviceAgentEvent.Type[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHANNEL_OPEN

public static final DeviceAgentEvent.Type CHANNEL_OPEN

Signifies that a channel between the agent and the device is open and the two can communicate.

CHANNEL_CLOSED

public static final DeviceAgentEvent.Type CHANNEL_CLOSED

Signifies that a channel between the agent and the device is closed and the two cannot communicate.

CHANNEL_ERROR

public static final DeviceAgentEvent.Type CHANNEL_ERROR

Signifies that a channel error has been detected. Further investigation should be performed to check if the channel is still open or closed.

ROLE_MASTER

public static final DeviceAgentEvent.Type ROLE_MASTER

Signifies that the agent has acquired master role.

ROLE_STANDBY

public static final DeviceAgentEvent.Type ROLE_STANDBY

Signifies that the agent has acquired standby/slave mastership role.

ROLE_NONE

public static final DeviceAgentEvent.Type ROLE_NONE

Signifies that the agent doesn't have any valid mastership role for the device.

NOT_MASTER

public static final DeviceAgentEvent.Type NOT_MASTER

Signifies that the agent tried to perform some operations on the device that requires master role.

Method Detail

values

public static DeviceAgentEvent.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DeviceAgentEvent.Type c : DeviceAgentEvent.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeviceAgentEvent.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null