Package adams.core.option

Interface OptionProducerWithOptionHandling<O,I>

Type Parameters:

O - the type of output data that gets generated

I - the internal type used while nesting

All Superinterfaces:

CleanUpHandler, Destroyable, OptionHandler, OptionProducer<O,I>

All Known Implementing Classes:

AbstractActorJavaCodeProducer, AbstractDocumentationProducer, AbstractFlowJavaCodeProducer, AbstractJavaCodeProducer, AbstractRecursiveOptionProducerWithOptionHandling, ActorExecutionClassProducer, ApplyActorProducer, DatabaseActorExecutionClassProducer, FlowJUnitTestProducer, FlowStructureDotProducer, FlowStructureGraphMLProducer, JavaInstantiationProducer, XhtmlProducer

public interface OptionProducerWithOptionHandling<O,I>
extends OptionProducer<O,I>, OptionHandler

Interface for option producers that offer option handling.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
void	cleanUpOptions()	Cleans up the options.
void	defineOptions()	Adds options to the internal list of options.
OptionManager	getOptionManager()	Returns the option manager.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

toCommandLine

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

Method Detail

defineOptions

void defineOptions()

Adds options to the internal list of options.

Every subclass needs to add the necessary Option objects to its internal List with Option objects.

Specified by:

defineOptions in interface OptionHandler

getOptionManager

OptionManager getOptionManager()

Returns the option manager.

Only needs to be implemented in the superclass, which declares the OptionManager object managing all the Option objects.

Specified by:

getOptionManager in interface OptionHandler

Returns:

the internal option list

cleanUpOptions

void cleanUpOptions()

Cleans up the options.

Specified by:

cleanUpOptions in interface OptionHandler