org.onosproject.incubator.net.tunnel

Enum Tunnel.State

java.lang.Object

java.lang.Enum<Tunnel.State>

org.onosproject.incubator.net.tunnel.Tunnel.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Tunnel.State>

Enclosing interface:

Tunnel

public static enum Tunnel.State
extends java.lang.Enum<Tunnel.State>

Representation of the tunnel state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Signifies that a tunnel is currently active.
ESTABLISHED Signifies that a tunnel is currently established but no traffic.
ESTABLISHING Signifies that a tunnel is being established.
FAILED Signifies that a tunnel is currently out of service.
INACTIVE Signifies that a tunnel is currently inactive.
INIT Signifies that a tunnel is currently in a initialized state.
REMOVING Signifies that a tunnel is being removed.
UNSTABLE Signifies that the tunnel's state is unreliable and should be setup again.

Method Summary

Modifier and Type	Method and Description
static Tunnel.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Tunnel.State[]	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

INIT

public static final Tunnel.State INIT

Signifies that a tunnel is currently in a initialized state.

ESTABLISHED

public static final Tunnel.State ESTABLISHED

Signifies that a tunnel is currently established but no traffic.

ACTIVE

public static final Tunnel.State ACTIVE

Signifies that a tunnel is currently active. This state means that this tunnel is available. It can be borrowed by consumer.

FAILED

public static final Tunnel.State FAILED

Signifies that a tunnel is currently out of service.

INACTIVE

public static final Tunnel.State INACTIVE

Signifies that a tunnel is currently inactive. This state means that this tunnel can not be borrowed by consumer.

UNSTABLE

public static final Tunnel.State UNSTABLE

Signifies that the tunnel's state is unreliable and should be setup again.

ESTABLISHING

public static final Tunnel.State ESTABLISHING

Signifies that a tunnel is being established.

REMOVING

public static final Tunnel.State REMOVING

Signifies that a tunnel is being removed.

Method Detail

values

public static Tunnel.State[] 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 (Tunnel.State c : Tunnel.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static Tunnel.State valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null