Package org.anchoranalysis.io.input.bean

Class InputManagerParameters

Object

org.anchoranalysis.io.input.bean.InputManagerParameters

public class InputManagerParameters
extends Object

Parameters passed to an InputManager to generate input-objects.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
InputManagerParameters(Logger logger)	Create with only a logger, and using sensible default values for the other fields.
InputManagerParameters(OperationContext operationContext)	Create with only a OperationContext, and using sensible default values for the other fields.
InputManagerParameters(InputContextParameters inputContext, OperationContext operationContext)

Method Summary

Modifier and Type	Method	Description
Optional<DebugModeParameters>	getDebugModeParameters()	Parameters for debug-mode (only defined if we are in debug mode).
ExecutionTimeRecorder	getExecutionTimeRecorder()	Allows for the execution time of certain operations to be recorded.
InputContextParameters	getInputContext()	Additional parameters that offer context for many beans that provide input-functions.
Logger	getLogger()	Where to write informative messages to, and and any non-fatal errors (fatal errors are throw as exceptions).
OperationContext	getOperationContext()	Allows for logging and recording the execution-time of particular operations.
boolean	isDebugModeActivated()	Whether debug-mode has been activated.

Methods inherited from class java.lang.Object

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

Constructor Details

InputManagerParameters

public InputManagerParameters(Logger logger)

Create with only a logger, and using sensible default values for the other fields.

Parameters:

logger - the logger.

InputManagerParameters

public InputManagerParameters(OperationContext operationContext)

Create with only a OperationContext, and using sensible default values for the other fields.

Parameters:

operationContext - context for logging and recording execution times.

InputManagerParameters

public InputManagerParameters(InputContextParameters inputContext, OperationContext operationContext)

Method Details

isDebugModeActivated

public boolean isDebugModeActivated()

Whether debug-mode has been activated.

Returns:

true iff debug-mode has been activated.

getDebugModeParameters

public Optional<DebugModeParameters> getDebugModeParameters()

Parameters for debug-mode (only defined if we are in debug mode).

Returns:

the parameters, if they exist.

getExecutionTimeRecorder

public ExecutionTimeRecorder getExecutionTimeRecorder()

Allows for the execution time of certain operations to be recorded.

Returns:

the execution-time-recorder.

getLogger

public Logger getLogger()

Where to write informative messages to, and and any non-fatal errors (fatal errors are throw as exceptions).

Returns:

the logger.

getInputContext

public InputContextParameters getInputContext()

Additional parameters that offer context for many beans that provide input-functions.

getOperationContext

public OperationContext getOperationContext()

Allows for logging and recording the execution-time of particular operations.