globals.trigger

Class AbstractTrigger

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.trigger.AbstractTrigger

All Implemented Interfaces:

Parameter, Trigger, Cloneable, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying, Triggering

Direct Known Subclasses:

InferPark, MissmatchTrigger, MoxaTrigger, SimpleTrigger, WeatherTrigger

public abstract class AbstractTrigger
extends AbstractParameter
implements Trigger

An intermediate class from an abstract parameter to a concrete trigger class. Links the Parameter.get() and Parameter.set(java.lang.Object) methods to the appropriate Triggering.getTrigger() and Triggering.setTrigger(java.lang.Boolean) method. The elapsed toggle time is linked to Triggering.getLastToggleTime(). Three methods have to be defined, #setTigger, Triggering.getTrigger() and Triggering.getLastToggleTime().

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields inherited from class globals.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTrigger(Map info) Constructs a abstract value.

Method Summary

Modifier and Type	Method and Description
Object	get() Links the Parameter.get() to the Triggering.getTrigger() method.
long	getElapsedToggleTime() Returns the elapsed time since the last toggle event.
boolean	isTrue() Returns the value of this trigger already interpreted as a primitive boolean.
Object	set(Object number) Links the Parameter.set(java.lang.Object) to the Triggering.setTrigger(java.lang.Boolean) method.
Boolean	toggleTrigger() Builds the toggle method.

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, init, overrideDefaultName, register, rescanned, setName, toString

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface globals.Parameter

getFormatted, getName, getString

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface util.Initializable

init

Methods inherited from interface util.Triggering

getLastToggleTime, getTrigger, setTrigger

Constructor Detail

AbstractTrigger

protected AbstractTrigger(Map info)

Constructs a abstract value. Used for constructor chaining.

Method Detail

get

public Object get()

Links the Parameter.get() to the Triggering.getTrigger() method.

Specified by:

get in interface Parameter

set

public Object set(Object number)

Links the Parameter.set(java.lang.Object) to the Triggering.setTrigger(java.lang.Boolean) method. If the argument cannot be cast into a Boolean or is null an IllegalArgumentException is thrown.

Specified by:

set in interface Parameter

Returns:

The previous value of this parameter.

isTrue

public boolean isTrue()

Returns the value of this trigger already interpreted as a primitive boolean. If the trigger was never set prior to this call, false is returned.

Specified by:

isTrue in interface Triggering

toggleTrigger

public Boolean toggleTrigger()

Builds the toggle method. If the actual value of the trigger is defined, it is inverted with a call to the Triggering.setTrigger(java.lang.Boolean) method.

Specified by:

toggleTrigger in interface Triggering

Returns:

The old value of the trigger.

getElapsedToggleTime

public long getElapsedToggleTime()

Returns the elapsed time since the last toggle event. If this trigger was never toggled, i.e. its state changed from one logical state to the other, -1 is returned.

Specified by:

getElapsedToggleTime in interface Triggering

Returns:

The time since the last toggle event, in ms, or -1