Package org.anchoranalysis.io.input

Class InputFromManagerDelegate<T extends InputFromManager>

Object

InputFromManagerDelegate<T>

Type Parameters:

T - inout-type

All Implemented Interfaces:

InputFromManager

Direct Known Subclasses:

AnnotationComparisonInput, AnnotationWithStrategy, ConvertNamedChannelsInputToStack

public abstract class InputFromManagerDelegate<T extends InputFromManager>
extends Object
implements InputFromManager

A base class for InputFromManager-implementing classes that delegate to another.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
InputFromManagerDelegate(T delegate)

Method Summary

Modifier and Type	Method	Description
void	close(ErrorReporter errorReporter)	Performs all tidying up, file-closing etc. after we are finished using the InputFromManager
protected T	getDelegate()	The delegate.
String	identifier()	A unique name associated with the input.
Optional<Path>	pathForBinding()	A path to a file from which this input originated.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.io.input.InputFromManager

allAssociatedPaths, asFile, identifierAsPath, pathForBindingRequired

Constructor Details

InputFromManagerDelegate

public InputFromManagerDelegate(T delegate)

Method Details

identifier

public String identifier()

Description copied from interface: InputFromManager

A unique name associated with the input.

The name should never begin with or end with whitespace.

It should never contain backslashes, but forward-slashes are permitted.

Specified by:

identifier in interface InputFromManager

Returns:

a string uniquely (in the current dataset) identifying the input in a meaningful way.

pathForBinding

public Optional<Path> pathForBinding()

Description copied from interface: InputFromManager

A path to a file from which this input originated.

This path is not guaranteed to be unique for each input i.e. multiple inputs may originate from the same path.

Specified by:

pathForBinding in interface InputFromManager

Returns:

the primary path associated with the input, if it exists.

close

public void close(ErrorReporter errorReporter)

Description copied from interface: InputFromManager

Performs all tidying up, file-closing etc. after we are finished using the InputFromManager

Specified by:

close in interface InputFromManager

Parameters:

errorReporter - whether errors are reported to.

toString

public String toString()

Overrides:

toString in class Object

getDelegate

protected T getDelegate()

The delegate.

Returns:

the delegate.