Package org.anchoranalysis.io.output.namestyle

Class OutputNameStyle

Object

OutputNameStyle

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IndexableOutputNameStyle, SimpleOutputNameStyle, WithoutOutputNameStyle

public abstract class OutputNameStyle
extends Object
implements Serializable

Base class for an approach to generate a filename for an output.

Author:

Owen Feehan

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OutputNameStyle()
OutputNameStyle(String outputName)	Creates a new OutputNameStyle instance.

Method Summary

Modifier and Type	Method	Description
abstract OutputNameStyle	duplicate()	Deep copy the current object.
abstract Optional<String>	filenameWithoutExtension()	The filename to be written, including prefix, suffix, etc. but excluding extension (and any period before the extension).
String	getOutputName()	An identifier used in rules to determine if an output is enabled or not.
void	setOutputName(String outputName)	An identifier used in rules to determine if an output is enabled or not.

Methods inherited from class java.lang.Object

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

Constructor Details

OutputNameStyle

public OutputNameStyle(String outputName)

Creates a new OutputNameStyle instance.

Parameters:

outputName - An identifier used in rules to determine if an output is enabled or not.

OutputNameStyle

public OutputNameStyle()

Method Details

filenameWithoutExtension

public abstract Optional<String> filenameWithoutExtension()

The filename to be written, including prefix, suffix, etc. but excluding extension (and any period before the extension).

Returns:

the filename (without an extension, including without the period before the extension), if one is defined. If one is not defined, the output is expected to occur without any filename.

duplicate

public abstract OutputNameStyle duplicate()

Deep copy the current object.

Returns:

a newly created copy.

getOutputName

public String getOutputName()

An identifier used in rules to determine if an output is enabled or not.

setOutputName

public void setOutputName(String outputName)

An identifier used in rules to determine if an output is enabled or not.