Package org.anchoranalysis.launcher.executor.selectparam

Interface SelectParam<T>

Type Parameters:

T - object-type that is used as a parameter for an experiment.

All Known Implementing Classes:

UseDefaultManager

public interface SelectParam<T>

Different methods of selecting an object T that is used as a parameter for an experiment.

Method Summary

Modifier and Type	Method	Description
String	describe()	Provides a string that can be displayed to the user to describe this particular SelectParam.
boolean	isDefault()	Checks if this is the default option that occurs without any additional user effort.
T	select(ExecutionArguments executionArguments)	Retrieves the parameter.

Method Details

select

T select(ExecutionArguments executionArguments)
  throws ExperimentExecutionException

Retrieves the parameter.

Note that the ExecutionArguments might be modified during this operation (e.g. adding a directory parameter).

Parameters:

executionArguments - the ExecutionArguments that may be modified during selection

Returns:

the selected parameter of type T

Throws:

ExperimentExecutionException - if an error occurs during parameter selection

isDefault

boolean isDefault()

Checks if this is the default option that occurs without any additional user effort.

Returns:

true if it is the default option, false otherwise

describe

String describe()
         throws ExperimentExecutionException

Provides a string that can be displayed to the user to describe this particular SelectParam.

Returns:

a descriptive string

Throws:

ExperimentExecutionException - if an error occurs while generating the description