prajna.io

Class BufferedFormatWriter<X>

java.lang.Object

prajna.io.BufferedFormatWriter<X>

Type Parameters:

X - The type of data written

All Implemented Interfaces:

FormatWriter<X>

public abstract class BufferedFormatWriter<X>
extends java.lang.Object
implements FormatWriter<X>

FormatWriter that includes a buffer that can be added to one record at a time. The buffer size may be set directly, indicating the size of the buffer. If the buffer fills, it is written to the output destination, and the buffer is cleared.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
BufferedFormatWriter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addToBuffer(X data) Add a record to the internal buffer.
void	close() Close the writer.
void	setBufferSize(int size) Set the buffer size.
void	writeBuffer() Write the buffer to the output destination, and ensure the information has been added correctly

Methods inherited from class java.lang.Object

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

Methods inherited from interface prajna.io.FormatWriter

getDestination, setDestination, writeData

Constructor Detail

BufferedFormatWriter

public BufferedFormatWriter()

Method Detail

addToBuffer

public boolean addToBuffer(X data)
                    throws java.io.IOException

Add a record to the internal buffer. If the buffer reaches its maximum size, the buffer is written to the output destination, and the buffer is cleared. If the buffer size is set to a negative number, this method never writes the buffer, and the buffer is only written when the writer is closed.

Parameters:

data - the data to write

Returns:

true if this method writes data to the output destination, false otherwise.

Throws:

java.io.IOException - if there is a problem writing files to the output destination.

close

public void close()

Close the writer. This method will try to write the buffer to the output destination before closing by invoking writeData() on the buffer

Specified by:

close in interface FormatWriter<X>

setBufferSize

public void setBufferSize(int size)

Set the buffer size. By default, the buffer size is set to 1000.

Parameters:

size - the buffer size

writeBuffer

public void writeBuffer()
                 throws java.io.IOException

Write the buffer to the output destination, and ensure the information has been added correctly

Throws:

java.io.IOException - if there is a problem writing files to the output destination.