Package com.inductiveautomation.ignition.gateway.redundancy.types

Enum Class ActivityLevel

java.lang.Object

java.lang.Enum<ActivityLevel>

com.inductiveautomation.ignition.gateway.redundancy.types.ActivityLevel

All Implemented Interfaces:

Localized, Serializable, Comparable<ActivityLevel>, Constable

public enum ActivityLevel
extends Enum<ActivityLevel>
implements Localized

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Active
Cold
Hot
Undecided
Warm

Method Summary

Modifier and Type	Method	Description
boolean	isHot()	Returns whether the activity level is Hot or Active, meaning the system allows load balancing.
boolean	isWarm()	Returns whether the system is at least "warm", meaning it should be doing something.
String	toString(Locale locale)
static ActivityLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActivityLevel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Undecided

public static final ActivityLevel Undecided

Cold

public static final ActivityLevel Cold

Warm

public static final ActivityLevel Warm

Hot

public static final ActivityLevel Hot

Active

public static final ActivityLevel Active

Method Details

values

public static ActivityLevel[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ActivityLevel valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isHot

public boolean isHot()

Returns whether the activity level is Hot or Active, meaning the system allows load balancing.

isWarm

public boolean isWarm()

Returns whether the system is at least "warm", meaning it should be doing something.

toString

public String toString(Locale locale)

Specified by:

toString in interface Localized