org.pepstock.charba.client.impl.charts

Enum GaugeThreshold

java.lang.Object

java.lang.Enum<GaugeThreshold>

org.pepstock.charba.client.impl.charts.GaugeThreshold

All Implemented Interfaces:

Serializable, Comparable<GaugeThreshold>

public enum GaugeThreshold
extends Enum<GaugeThreshold>

Default gauge thresholds.

Author:

Andrea "Stock" Stocchero

See Also:

IsThreshold

Enum Constant Summary

Enum Constants

Enum Constant and Description
CRITICAL the critical threshold.
NORMAL the normal threshold
WARNING the warning threshold.

Method Summary

Modifier and Type	Method and Description
static void	checkIfValid(org.pepstock.charba.client.impl.charts.IsThreshold threshold) Checks if threshold passed as argument is not null and its properties are not null.
IsColor	getColor() Returns the color of threshold.
String	getName() Returns the name of threshold.
Threshold	getThreshold() Creates a new threshold cloning the constant one.
double	getValue() Returns the value of threshold.
static boolean	isValid(org.pepstock.charba.client.impl.charts.IsThreshold threshold) Returns true if threshold passed as argument is not null and its properties are not null.
static GaugeThreshold	valueOf(String name) Returns the enum constant of this type with the specified name.
static GaugeThreshold[]	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

NORMAL

public static final GaugeThreshold NORMAL

the normal threshold

WARNING

public static final GaugeThreshold WARNING

the warning threshold.

CRITICAL

public static final GaugeThreshold CRITICAL

the critical threshold.

Method Detail

values

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

Returns:

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

valueOf

public static GaugeThreshold 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

getValue

public double getValue()

Returns the value of threshold.

Returns:

the value of threshold.

getColor

public IsColor getColor()

Returns the color of threshold.

Returns:

the color of threshold.

getName

public String getName()

Returns the name of threshold.

Returns:

the name of threshold.

getThreshold

public Threshold getThreshold()

Creates a new threshold cloning the constant one. This is helpful to change standard color or value.

Returns:

the threshold

isValid

public static boolean isValid(org.pepstock.charba.client.impl.charts.IsThreshold threshold)

Returns true if threshold passed as argument is not null and its properties are not null.

Parameters:

threshold - threshold to be checked

Returns:

true if threshold passed as argument is not null and its properties are not null

checkIfValid

public static void checkIfValid(org.pepstock.charba.client.impl.charts.IsThreshold threshold)

Checks if threshold passed as argument is not null and its properties are not null. If not, throw a IllegalArgumentException.

Parameters:

threshold - threshold to be checked