Package org.anchoranalysis.io.generator.text

Class StringGenerator

Object

SingleFileTypeGenerator<String,String>

OneStageGenerator<String>

StringGenerator

All Implemented Interfaces:

Generator<String>, TransformingGenerator<String,String>, ElementWriter<String>

public class StringGenerator
extends OneStageGenerator<String>

A generator that writes the contents of a String to the file-system as text-file.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
StringGenerator()

Method Summary

Modifier and Type	Method	Description
String	selectFileExtension(OutputWriteSettings settings, Optional<Logger> logger)	Selects the file/extension to be used for outputting the file.
void	writeToFile(String element, OutputWriteSettings settings, Path filePath)	Write generated content for {code element} to the file filePath.

Methods inherited from class org.anchoranalysis.io.generator.OneStageGenerator

transform

Methods inherited from class org.anchoranalysis.io.generator.SingleFileTypeGenerator

write, writeWithIndex

Methods inherited from class java.lang.Object

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

Constructor Details

StringGenerator

public StringGenerator()

Method Details

writeToFile

public void writeToFile(String element,
 OutputWriteSettings settings,
 Path filePath)
                 throws OutputWriteFailedException

Description copied from class: SingleFileTypeGenerator

Write generated content for {code element} to the file filePath.

This function deliberately leaves ambiguity over what occurs if a file already exists at filePath.

Specified by:

writeToFile in class SingleFileTypeGenerator<String,String>

Parameters:

element - element to be assigned and then transformed.

settings - settings for outputting.

filePath - the path to the file to write to.

Throws:

OutputWriteFailedException - if the content cannot be written successfully.

selectFileExtension

public String selectFileExtension(OutputWriteSettings settings,
 Optional<Logger> logger)

Description copied from class: SingleFileTypeGenerator

Selects the file/extension to be used for outputting the file.

Specified by:

selectFileExtension in class SingleFileTypeGenerator<String,String>

Parameters:

settings - settings for outputting.

logger - logger for warning for information messages when outputting.

Returns:

the file extension (without leading period) to be used for outputting.