Package adams.core.option

Class AbstractRecursiveOptionProducerWithOptionHandling<O,I>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.option.AbstractOptionProducer<O,I>

adams.core.option.AbstractRecursiveOptionProducer<O,I>

adams.core.option.AbstractRecursiveOptionProducerWithOptionHandling<O,I>

Type Parameters:

O - the type of output data that gets generated

I - the internal type used while nesting

All Implemented Interfaces:

CleanUpHandler, Destroyable, LoggingSupporter, OptionHandler, OptionProducer<O,I>, OptionProducerWithOptionHandling<O,I>, RecursiveOptionProducer, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractDocumentationProducer, AbstractJavaCodeProducer, FlowStructureDotProducer, FlowStructureGraphMLProducer

public abstract class AbstractRecursiveOptionProducerWithOptionHandling<O,I>
extends AbstractRecursiveOptionProducer<O,I>
implements OptionProducerWithOptionHandling<O,I>

Ancestor for recursive option producers that offer option handling.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected OptionManager	m_OptionManager	for managing the available options.

Fields inherited from class adams.core.option.AbstractRecursiveOptionProducer

m_Nesting

Fields inherited from class adams.core.option.AbstractOptionProducer

m_Input, m_LastGenerated, m_Output, m_OutputVariableValues, m_SkippedProperties, m_UsePropertyNames

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractRecursiveOptionProducerWithOptionHandling()	Initializes the visitor.

Method Summary

Modifier and Type	Method	Description
void	cleanUpOptions()	Cleans up the options.
void	defineOptions()	Adds options to the internal list of options.
void	destroy()	Frees up memory in a "destructive" non-reversible way.
protected void	finishInit()	Finishes the initialization in the constructor.
OptionManager	getOptionManager()	Returns the option manager.
protected OptionManager	newOptionManager()	Returns a new instance of the option manager.
String	toCommandLine()	Returns the commandline string.

Methods inherited from class adams.core.option.AbstractRecursiveOptionProducer

cleanUp, generateLoggingString, getDebugIndentation, getDebugIndentation, getRecursionLevel, reset

Methods inherited from class adams.core.option.AbstractOptionProducer

checkInput, doProduce, doProduce, getCurrentValue, getInput, getOptionIdentifier, getOutput, getOutputVariableValues, getSkippedProperties, getUsePropertyNames, globalInfo, initialize, initOutput, isDefaultValue, loggingLevelTipText, main, outputVariableValuesTipText, postProduce, postProduce, preProduce, preProduce, processOption, processOption, processOption, produce, produce, runProducer, setLoggingLevel, setOutputVariableValues, setSkippedProperties, toString, toString, write

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.option.OptionProducer

cleanUp, doProduce, getInput, getLoggingLevel, getOutput, getOutputVariableValues, getSkippedProperties, getUsePropertyNames, globalInfo, loggingLevelTipText, outputVariableValuesTipText, processOption, processOption, processOption, produce, setLoggingLevel, setOutputVariableValues, setSkippedProperties, toString, write

Field Detail

m_OptionManager

protected OptionManager m_OptionManager

for managing the available options.

Constructor Detail

AbstractRecursiveOptionProducerWithOptionHandling

public AbstractRecursiveOptionProducerWithOptionHandling()

Initializes the visitor.

Method Detail

newOptionManager

protected OptionManager newOptionManager()

Returns a new instance of the option manager.

Returns:

the manager to use

defineOptions

public void defineOptions()

Adds options to the internal list of options. Derived classes must override this method to add additional options.

Specified by:

defineOptions in interface OptionHandler

Specified by:

defineOptions in interface OptionProducerWithOptionHandling<O,I>

finishInit

protected void finishInit()

Finishes the initialization in the constructor.

Default implementation does nothing.

getOptionManager

public OptionManager getOptionManager()

Returns the option manager.

Specified by:

getOptionManager in interface OptionHandler

Specified by:

getOptionManager in interface OptionProducerWithOptionHandling<O,I>

Returns:

the manager

cleanUpOptions

public void cleanUpOptions()

Cleans up the options.

Specified by:

cleanUpOptions in interface OptionHandler

Specified by:

cleanUpOptions in interface OptionProducerWithOptionHandling<O,I>

destroy

public void destroy()

Frees up memory in a "destructive" non-reversible way.

Cleans up the options.

Specified by:

destroy in interface Destroyable

See Also:

cleanUpOptions()

toCommandLine

public String toCommandLine()

Returns the commandline string.

Specified by:

toCommandLine in interface OptionHandler

Returns:

the commandline