Module com.aoapps.io.buffer

Package com.aoapps.io.buffer

Class BufferWriter

java.lang.Object

java.io.Writer

com.aoapps.io.buffer.BufferWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

AutoTempFileWriter, CharArrayBufferWriter, LoggingWriter, NullBufferWriter, SegmentedWriter, TempFileWriter

public abstract class BufferWriter
extends Writer

A buffered writer with results that may be trimmed, converted to String, and written to another writer.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BufferWriter()

Method Summary

Modifier and Type	Method	Description
abstract long	getLength()	Gets the number of characters in this buffer.
abstract BufferResult	getResult()	Gets the result from this buffer.
abstract String	toString()	Gets a short message (like type and length).

Methods inherited from class java.io.Writer

append, append, append, close, flush, nullWriter, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Details

BufferWriter

protected BufferWriter()

Method Details

getLength

public abstract long getLength()
                        throws IOException

Gets the number of characters in this buffer. Once closed, this length will not be modified.

Throws:

IOException

toString

public abstract String toString()

Gets a short message (like type and length).

Overrides:

toString in class Object

See Also:

• To get access to the buffered content.

getResult

public abstract BufferResult getResult()
                                throws IllegalStateException,
IOException

Gets the result from this buffer. The buffer must be closed.

Note: Although the BufferWriter are generally not thread-safe, the BufferResult is thread-safe. It is expected to commonly create a buffer on one thread, but the be able to safely share the result among many threads.

Throws:

IllegalStateException - if not closed

IOException