de.zmt.output.writing

Interface OutputWriter

All Superinterfaces:

AutoCloseable, Closeable, Serializable

All Known Implementing Classes:

LineOutputWriter, MultiLineOutputWriter, OneShotOutputWriter

public interface OutputWriter
extends Serializable, Closeable

A writer used to write collected data.

Field Summary

Fields

Modifier and Type	Field and Description
static OutputWriter	EMPTY An empty writer that does nothing.

Method Summary

Modifier and Type	Method and Description
default void	close() If this writer keeps any resources open that needs closing, it has to be done here.
void	setOutputPath(Path outputPath) Sets the output path for this writer.
void	writeValues(long steps) Implementing classes need to specify how to write values.

Field Detail

EMPTY

static final OutputWriter EMPTY

An empty writer that does nothing.

Method Detail

writeValues

void writeValues(long steps)
          throws IOException

Implementing classes need to specify how to write values. Called after the collection process.

Parameters:

steps - the number of steps passed in Schedule

Throws:

IOException - If an I/O error occurs

setOutputPath

void setOutputPath(Path outputPath)

Sets the output path for this writer. The path is assumed to point to an existing directory.

Will be called during deserialization from Output for all associated writers. No need to handle serialization within implementation.

Parameters:

outputPath - the output path

close

default void close()
            throws IOException

If this writer keeps any resources open that needs closing, it has to be done here. Default implementation is an empty method.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException