Package adams.core.option

Class AbstractOptionTraverserWithResult<T>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.option.AbstractOptionTraverser

adams.core.option.AbstractOptionTraverserWithResult<T>

Type Parameters:

T - the type of the result

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, OptionTraverser, OptionTraverserWithResult<T>, SizeOfHandler, Serializable

Direct Known Subclasses:

ErrorHandlerInstanceLister, FileLister, VariableLister, VariablesFinder, VariablesInstanceLister

public abstract class AbstractOptionTraverserWithResult<T>
extends AbstractOptionTraverser
implements OptionTraverserWithResult<T>

Ancestor for option traversers that return a result.

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
AbstractOptionTraverserWithResult()

Method Summary

Modifier and Type	Method	Description
abstract T	getResult()	Returns the result of the traversal.
protected void	reset()	Resets the object.
abstract void	resetResult()	Resets the result before traversing.

Methods inherited from class adams.core.option.AbstractOptionTraverser

canHandle, canRecurse, canRecurse, globalInfo, handleArgumentOption, handleBooleanOption, handleClassOption

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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

Methods inherited from interface adams.core.option.OptionTraverser

canHandle, canRecurse, canRecurse, handleArgumentOption, handleBooleanOption, handleClassOption

Constructor Detail

AbstractOptionTraverserWithResult

public AbstractOptionTraverserWithResult()

Method Detail

reset

protected void reset()

Resets the object.

Overrides:

reset in class AbstractOptionHandler

resetResult

public abstract void resetResult()

Resets the result before traversing.

Specified by:

resetResult in interface OptionTraverserWithResult<T>

getResult

public abstract T getResult()

Returns the result of the traversal.

Specified by:

getResult in interface OptionTraverserWithResult<T>

Returns:

the result