Module com.aoapps.io.buffer

Package com.aoapps.io.buffer

Class AutoTempFileWriter

java.lang.Object

java.io.Writer

com.aoapps.io.buffer.BufferWriter

com.aoapps.io.buffer.AutoTempFileWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class AutoTempFileWriter
extends BufferWriter

Writes to an initial buffer then switches to a temp file when the threshold is reached.

This class is not thread safe.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_TEMP_FILE_THRESHOLD	A reasonable default temp file threshold, currently 4 MB.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AutoTempFileWriter(BufferWriter initialBuffer, TempFileContext tempFileContext)	Uses the default temp file threshold.
AutoTempFileWriter(BufferWriter initialBuffer, TempFileContext tempFileContext, long tempFileThreshold)

Method Summary

Modifier and Type	Method	Description
AutoTempFileWriter	append(char c)
AutoTempFileWriter	append(CharSequence csq)
AutoTempFileWriter	append(CharSequence csq, int start, int end)
void	close()
void	flush()
long	getLength()	Gets the number of characters in this buffer.
BufferResult	getResult()	Gets the result from this buffer.
String	toString()	Gets a short message (like type and length).
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TEMP_FILE_THRESHOLD

public static final long DEFAULT_TEMP_FILE_THRESHOLD

A reasonable default temp file threshold, currently 4 MB.

See Also:

• Constant Field Values

Constructor Details

AutoTempFileWriter

public AutoTempFileWriter(BufferWriter initialBuffer,
 TempFileContext tempFileContext,
 long tempFileThreshold)

AutoTempFileWriter

public AutoTempFileWriter(BufferWriter initialBuffer,
 TempFileContext tempFileContext)

Uses the default temp file threshold.

Method Details

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(char[] cbuf,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

write

public void write(String str)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

write

public void write(String str,
 int off,
 int len)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

append

public AutoTempFileWriter append(CharSequence csq)
                          throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public AutoTempFileWriter append(CharSequence csq,
 int start,
 int end)
                          throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public AutoTempFileWriter append(char c)
                          throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

getLength

public long getLength()
               throws IOException

Description copied from class: BufferWriter

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

Specified by:

getLength in class BufferWriter

Throws:

IOException

toString

public String toString()

Description copied from class: BufferWriter

Gets a short message (like type and length).

Specified by:

toString in class BufferWriter

See Also:

• To get access to the buffered content.

getResult

public BufferResult getResult()
                       throws IllegalStateException,
IOException

Description copied from class: BufferWriter

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.

Specified by:

getResult in class BufferWriter

Throws:

IllegalStateException - if not closed

IOException