Package org.molgenis.vibe.cli.io.output.target

Class FileOutputWriter

java.lang.Object

org.molgenis.vibe.cli.io.output.target.FileOutputWriter

All Implemented Interfaces:

OutputWriter

public class FileOutputWriter
extends Object
implements OutputWriter

Writer for writing output to a file.

Constructor Summary

Constructors

Constructor	Description
FileOutputWriter(Path path)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes output target.
Path	getPath()
void	initialize()	Makes preparations for writing output to an output target.
String	target()	Returns a String describing the target to which the output is written (primarily for logging purposes).
void	write(String output)	Writes single piece of information to output target.
void	writeHeader(String output)	Writes the header (if available) to the output target.
void	writeNewLine()	Generates a newline (if possible) in the output target.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileOutputWriter

public FileOutputWriter(Path path)

Method Detail

getPath

public Path getPath()

target

public String target()

Description copied from interface: OutputWriter

Returns a String describing the target to which the output is written (primarily for logging purposes).

Specified by:

target in interface OutputWriter

Returns:

a String describing the target to which the output is written to.

initialize

public void initialize()
                throws IOException

Description copied from interface: OutputWriter

Makes preparations for writing output to an output target. The default is empty and should be overridden by the implementation if an initialize() step is needed before actual data is written.

Specified by:

initialize in interface OutputWriter

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: OutputWriter

Closes output target. The default is empty and should be overridden by the implementation if a close() step is needed after the data is written (to cleanly close off the target opened during initialize()).

Specified by:

close in interface OutputWriter

Throws:

IOException

write

public void write(String output)
           throws IOException

Description copied from interface: OutputWriter

Writes single piece of information to output target.

Specified by:

write in interface OutputWriter

Parameters:

output - the output to be written to the output target

Throws:

IOException

writeHeader

public void writeHeader(String output)
                 throws IOException

Description copied from interface: OutputWriter

Writes the header (if available) to the output target.

Specified by:

writeHeader in interface OutputWriter

Throws:

IOException

writeNewLine

public void writeNewLine()
                  throws IOException

Description copied from interface: OutputWriter

Generates a newline (if possible) in the output target.

Specified by:

writeNewLine in interface OutputWriter

Throws:

IOException