stella
Interface ErrorFinalizing

All Superinterfaces:

PropertySupplying

All Known Implementing Classes:

AbstractErrorFinalizer, GoodWeatherFinalizer, LostGuidingFinalizer, MailFinalizer, MasterErrorHandler.NoneErrorFinalizer, RegainedGuidingFinalizer, ResendCommandFinalizer, ResetFinalizer, SequenceErrorFinalizer, WakeFinalizer, XMLErrorFinalizer

public interface ErrorFinalizing
extends PropertySupplying

An interface that describes object that can handle & finalize a single ErrorEvents. For each follow-up one error finalizer should be present. Errors that can be handled in a similar way may refer to the same class, but with different properties.

Instances of this class are used in the MasterErrorHandler to distribute incoming errors.

Field Summary

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

boolean	finalizeError(TargetDefinition executing, ErrorEvent occured, CommandLaunching[] launch, Sequencing seq, ParameterClustering set) Finalizes the error.
String	getFollowUp() Gets the follow-up this error finalizer can deal with.
boolean	isAborting() Returns true, if this finalizer is currently aborting a target.
boolean	isFinalizing() Returns true, if this finalizer is currently finalizing an error.
void	setMonitor(Object monitor) Sets a monitor object.

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

Method Detail

getFollowUp

String getFollowUp()

Gets the follow-up this error finalizer can deal with. The string returned herre should be one of the ErrorEvent follow-ups.

finalizeError

boolean finalizeError(TargetDefinition executing,
                      ErrorEvent occured,
                      CommandLaunching[] launch,
                      Sequencing seq,
                      ParameterClustering set)

Finalizes the error. If finalization was not possible, false is returned. If the error finalizer needs to alter the current sequencer or needs to look up certain parameters, these are handed over at method invocation. This method should return fast, i.e. it should spawn its own thread if necessary.

isFinalizing

boolean isFinalizing()

Returns true, if this finalizer is currently finalizing an error.

isAborting

boolean isAborting()

Returns true, if this finalizer is currently aborting a target.

setMonitor

void setMonitor(Object monitor)

Sets a monitor object. A monitor can be woken up during error finalizing like waking the master mind in case of good/bad weather.