Package adams.flow.control.errorpostprocessor

Class AbstractErrorPostProcessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.errorpostprocessor.AbstractErrorPostProcessor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ErrorPostProcessor, Serializable

Direct Known Subclasses:

Null, OutOfMemory

public abstract class AbstractErrorPostProcessor
extends AbstractOptionHandler
implements ErrorPostProcessor

Ancestor for post-processors for error messages. To be used by error handlers.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractErrorPostProcessor()

Method Summary

Modifier and Type	Method	Description
protected void	check(ErrorHandler handler, Actor source, String type, String msg)	Hook method for checks.
protected abstract void	doPostProcessError(ErrorHandler handler, Actor source, String type, String msg)	Performs the actual post-processing of the error.
void	postProcessError(ErrorHandler handler, Actor source, String type, String msg)	Post-processes the error.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractErrorPostProcessor

public AbstractErrorPostProcessor()

Method Detail

check

protected void check(ErrorHandler handler,
                     Actor source,
                     String type,
                     String msg)

Hook method for checks.
Default implementation ensures that error handler, source actor and error message are present.

Parameters:

handler - the error handler that this call comes from

source - the source actor where the error originated

type - the type of error

msg - the error message

doPostProcessError

protected abstract void doPostProcessError(ErrorHandler handler,
                                           Actor source,
                                           String type,
                                           String msg)

Performs the actual post-processing of the error.

Parameters:

handler - the error handler that this call comes from

source - the source actor where the error originated

type - the type of error

msg - the error message

postProcessError

public void postProcessError(ErrorHandler handler,
                             Actor source,
                             String type,
                             String msg)

Post-processes the error.

Specified by:

postProcessError in interface ErrorPostProcessor

Parameters:

handler - the error handler that this call comes from

source - the source actor where the error originated

type - the type of error

msg - the error message