Class UseDefaultManager

Object

UseDefaultManager

All Implemented Interfaces:

SelectParam<Optional<Path>>

public class UseDefaultManager
extends Object
implements SelectParam<Optional<Path>>

Uses whatever default-manager exists

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
UseDefaultManager()

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.
Optional<Path>	select(ExecutionArguments executionArguments)	Retrieves the parameter.

Methods inherited from class java.lang.Object

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

Constructor Details

UseDefaultManager

public UseDefaultManager()

Method Details

select

public Optional<Path> select(ExecutionArguments executionArguments)

Description copied from interface: SelectParam

Retrieves the parameter.

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

Specified by:

select in interface SelectParam<Optional<Path>>

Parameters:

executionArguments - the ExecutionArguments that may be modified during selection

Returns:

the selected parameter of type T

isDefault

public boolean isDefault()

Description copied from interface: SelectParam

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

Specified by:

isDefault in interface SelectParam<Optional<Path>>

Returns:

true if it is the default option, false otherwise

describe

public String describe()
                throws ExperimentExecutionException

Description copied from interface: SelectParam

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

Specified by:

describe in interface SelectParam<Optional<Path>>

Returns:

a descriptive string

Throws:

ExperimentExecutionException - if an error occurs while generating the description