net.anotheria.moskito.core.threshold.guard

Enum GuardedDirection

java.lang.Object

java.lang.Enum<GuardedDirection>

net.anotheria.moskito.core.threshold.guard.GuardedDirection

All Implemented Interfaces:

Serializable, Comparable<GuardedDirection>

public enum GuardedDirection
extends Enum<GuardedDirection>

Describes possible direction which can be bypassed by the threshold.

Author:

lrosenberg

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN The new value is lower than the guarded value.
UP The new value is higher than the guarded value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	brokeThrough(Number value, Number limit) Returns true if the threshold guard is passed (and the threshold guard should fire).
static GuardedDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static GuardedDirection[]	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

DOWN

public static final GuardedDirection DOWN

The new value is lower than the guarded value.

UP

public static final GuardedDirection UP

The new value is higher than the guarded value.

Method Detail

values

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

Returns:

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

valueOf

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

brokeThrough

public boolean brokeThrough(Number value,
                   Number limit)

Returns true if the threshold guard is passed (and the threshold guard should fire).

Parameters:

value -

limit -

Returns: