Package org.anchoranalysis.io.output.namestyle

Class StringSuffixOutputNameStyle

Object

org.anchoranalysis.io.output.namestyle.OutputNameStyle

org.anchoranalysis.io.output.namestyle.IndexableOutputNameStyle

org.anchoranalysis.io.output.namestyle.StringSuffixOutputNameStyle

All Implemented Interfaces:

Serializable

public class StringSuffixOutputNameStyle
extends IndexableOutputNameStyle

Outputs a file-name involving a string suffix.

Author:

Owen Feehan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StringSuffixOutputNameStyle()	Empty constructor, as needed for deserialization.
StringSuffixOutputNameStyle(String outputName, Optional<String> prefix)	Creates with an output-name.

Method Summary

Modifier and Type	Method	Description
IndexableOutputNameStyle	duplicate()	Deep copy the current object.
protected String	filenameFromOutputFormatString(String outputFormatString, String index)	Constructs a file name from the output format string and an index.
protected String	outputFormatString()	A format-string as recognized by String.format(java.lang.String, java.lang.Object...) that expects a single string element.

Methods inherited from class org.anchoranalysis.io.output.namestyle.IndexableOutputNameStyle

filenameWithoutExtension, filenameWithoutExtension, filenameWithoutExtension

Methods inherited from class org.anchoranalysis.io.output.namestyle.OutputNameStyle

getOutputName, setOutputName

Methods inherited from class java.lang.Object

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

Constructor Details

StringSuffixOutputNameStyle

public StringSuffixOutputNameStyle()

Empty constructor, as needed for deserialization.

StringSuffixOutputNameStyle

public StringSuffixOutputNameStyle(String outputName, Optional<String> prefix)

Creates with an output-name.

Parameters:

outputName - the output-name (without any prefix).

prefix - an optional prefix that is prepended to outputName.

Method Details

duplicate

public IndexableOutputNameStyle duplicate()

Description copied from class: OutputNameStyle

Deep copy the current object.

Specified by:

duplicate in class IndexableOutputNameStyle

Returns:

a newly created copy.

filenameFromOutputFormatString

protected String filenameFromOutputFormatString(String outputFormatString, String index)

Description copied from class: IndexableOutputNameStyle

Constructs a file name from the output format string and an index.

Specified by:

filenameFromOutputFormatString in class IndexableOutputNameStyle

Parameters:

outputFormatString - a format-string as recognized by String.format(java.lang.String, java.lang.Object...) that expects a single string element (what will be populated by index) to form the name.

index - the index, unique within a set of filenames being outputted.

Returns:

the file-name as a string.

outputFormatString

protected String outputFormatString()

Description copied from class: IndexableOutputNameStyle

A format-string as recognized by String.format(java.lang.String, java.lang.Object...) that expects a single string element.

Specified by:

outputFormatString in class IndexableOutputNameStyle

Returns:

the format-string.