org.metafacture.io

Class ByteStreamFileWriter

java.lang.Object

org.metafacture.framework.helpers.DefaultLifeCycle

org.metafacture.framework.helpers.DefaultObjectReceiver<byte[]>

org.metafacture.io.ByteStreamFileWriter

All Implemented Interfaces:

org.metafacture.framework.LifeCycle, org.metafacture.framework.ObjectReceiver<byte[]>, org.metafacture.framework.Receiver

public class ByteStreamFileWriter
extends org.metafacture.framework.helpers.DefaultObjectReceiver<byte[]>

Writes byte arrays to regular output files.

The module opens a new output file when it receives a reset-stream event. The setFileNameSupplier(Supplier) enables users to specify a new file name on each invocation. the setAppendIfFileExists(boolean) can be used to control whether existing files should be overwritten or appended to.

Constructor Summary

Constructors

Constructor and Description
ByteStreamFileWriter() Creates an instance of ByteStreamFileWriter.

Method Summary

Modifier and Type	Method and Description
void	closeStream() Closes the current output file.
void	process(byte[] bytes) Writes bytes to file.
void	resetStream() Opens a new output file.
void	setAppendIfFileExists(boolean appendIfFileExists) Controls whether to open files in append mode if they exist.
void	setFileNameSupplier(java.util.function.Supplier<java.io.File> fileNameSupplier) Supplier for file names.
void	setFlushAfterWrite(boolean flushAfterWrite) Controls whether the output stream is flushed after each write operation in process(byte[]).

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteStreamFileWriter

public ByteStreamFileWriter()

Creates an instance of ByteStreamFileWriter.

Method Detail

setFileNameSupplier

public void setFileNameSupplier(java.util.function.Supplier<java.io.File> fileNameSupplier)

Supplier for file names.

A new output file is created when process(byte[]) is called for the first time or whenever resetStream() is called. The name of the new file is fetched from the fileNameSupplier.

There is no default value. A file name supplier must be specified.

This property can be changed anytime during processing. It becomes effective the next time a new output file is opened.

Parameters:

fileNameSupplier - a supplier that returns file names.

setAppendIfFileExists

public void setAppendIfFileExists(boolean appendIfFileExists)

Controls whether to open files in append mode if they exist.

The default value is false.

This property can be changed anytime during processing. It becomes effective the next time a new output file is opened.

Parameters:

appendIfFileExists - true if new data should be appended, false to overwrite the existing file.

setFlushAfterWrite

public void setFlushAfterWrite(boolean flushAfterWrite)

Controls whether the output stream is flushed after each write operation in process(byte[]).

The default value is false.

This property can be changed anytime during processing. It becomes effective on the next invocation of process(byte[]).

Parameters:

flushAfterWrite - true if the output stream should be flushed after every write.

process

public void process(byte[] bytes)

Writes bytes to file.

Specified by:

process in interface org.metafacture.framework.ObjectReceiver<byte[]>

Overrides:

process in class org.metafacture.framework.helpers.DefaultObjectReceiver<byte[]>

Parameters:

bytes - to write to file

Throws:

WriteFailed - if an IO error occurred

resetStream

public void resetStream()

Opens a new output file.

Specified by:

resetStream in interface org.metafacture.framework.LifeCycle

Overrides:

resetStream in class org.metafacture.framework.helpers.DefaultLifeCycle

Throws:

CloseFailed - if the current output file could not be closed.

OpenFailed - if the new output file could not be opened.

closeStream

public void closeStream()

Closes the current output file.

Specified by:

closeStream in interface org.metafacture.framework.LifeCycle

Overrides:

closeStream in class org.metafacture.framework.helpers.DefaultLifeCycle

Throws:

CloseFailed - if the output file could not be closed.