com.whizzosoftware.hobson.api.task.condition

Enum ConditionClassType

java.lang.Object

java.lang.Enum<ConditionClassType>

com.whizzosoftware.hobson.api.task.condition.ConditionClassType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConditionClassType>

public enum ConditionClassType
extends java.lang.Enum<ConditionClassType>

An enumeration for types of condition classes.

Author:

Dan Noguerol

Enum Constant Summary

Enum Constants

Enum Constant and Description
evaluator Indicates an evaluator condition -- one that is evaluated if and only if a task's trigger condition has occurred.
trigger Indicates a trigger condition -- one associated with a specific plugin that knows how to detect when such a condition occurs.

Method Summary

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

trigger

public static final ConditionClassType trigger

Indicates a trigger condition -- one associated with a specific plugin that knows how to detect when such a condition occurs. For example, the scheduler plugin knows how to detect when a scheduled task trigger occurs based on its condition (e.g. every Wednesday at 1pm).

evaluator

public static final ConditionClassType evaluator

Indicates an evaluator condition -- one that is evaluated if and only if a task's trigger condition has occurred. For example, a trigger condition might indicate "if device A turns on" and an evaluator condition might make that more specific such as "only if device B is already on". If a task has passed all its evaluator conditions (or doesn't have any) then the task can be executed.

Method Detail

values

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

Returns:

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

valueOf

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