org.onosproject.upgrade

Enum Upgrade.Status

java.lang.Object

java.lang.Enum<Upgrade.Status>

org.onosproject.upgrade.Upgrade.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Upgrade.Status>

Enclosing class:

Upgrade

@Beta
public static enum Upgrade.Status
extends java.lang.Enum<Upgrade.Status>

Represents the phase of the upgrade protocol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMITTED Indicates that an upgrade has been committed.
COMMITTING d Indicates that an upgrade is being committed.
INACTIVE Represents state in which no upgrade has been initialized.
INITIALIZED Indicates that an upgrade has been initialized.
INITIALIZING Indicates that an upgrade is being initialized.
RESET Indicates that an upgrade has been reset.
RESETTING Indicates that an upgrade is being reset.
ROLLED_BACK Indicates that an upgrade has been rolled back.
ROLLING_BACK Indicates that an upgrade is being rolled back.
UPGRADED Indicates that an upgrade is complete.
UPGRADING Indicates that an upgrade is in progress.

Method Summary

Modifier and Type	Method and Description
boolean	active() Returns whether the upgrade status is active.
boolean	upgraded() Returns whether the upgraded version is active.
static Upgrade.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Upgrade.Status[]	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

INACTIVE

public static final Upgrade.Status INACTIVE

Represents state in which no upgrade has been initialized.

INITIALIZING

public static final Upgrade.Status INITIALIZING

Indicates that an upgrade is being initialized.

INITIALIZED

public static final Upgrade.Status INITIALIZED

Indicates that an upgrade has been initialized.

UPGRADING

public static final Upgrade.Status UPGRADING

Indicates that an upgrade is in progress.

UPGRADED

public static final Upgrade.Status UPGRADED

Indicates that an upgrade is complete.

COMMITTING

public static final Upgrade.Status COMMITTING

d Indicates that an upgrade is being committed.

COMMITTED

public static final Upgrade.Status COMMITTED

Indicates that an upgrade has been committed.

ROLLING_BACK

public static final Upgrade.Status ROLLING_BACK

Indicates that an upgrade is being rolled back.

ROLLED_BACK

public static final Upgrade.Status ROLLED_BACK

Indicates that an upgrade has been rolled back.

RESETTING

public static final Upgrade.Status RESETTING

Indicates that an upgrade is being reset.

RESET

public static final Upgrade.Status RESET

Indicates that an upgrade has been reset.

Method Detail

values

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

Returns:

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

valueOf

public static Upgrade.Status 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

active

public boolean active()

Returns whether the upgrade status is active.

Returns:

whether the upgrade status is active

upgraded

public boolean upgraded()

Returns whether the upgraded version is active.

Returns:

whether the upgraded version is active