Module com.aoapps.io.buffer

Package com.aoapps.io.buffer

Class LoggingWriter

java.lang.Object

java.io.Writer

com.aoapps.io.buffer.BufferWriter

com.aoapps.io.buffer.LoggingWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class LoggingWriter
extends BufferWriter

Logs all write calls in a way that can be put into Java source code. This is used to capture real-world scenarios for unit testing.

This class is not thread safe.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
LoggingWriter(BufferWriter wrapped, Writer log)

Method Summary

Modifier and Type	Method	Description
LoggingWriter	append(char c)
LoggingWriter	append(CharSequence csq)
LoggingWriter	append(CharSequence csq, int start, int end)
void	close()
void	flush()
long	getId()
long	getLength()	Gets the number of characters in this buffer.
LoggingResult	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

Constructor Details

LoggingWriter

public LoggingWriter(BufferWriter wrapped,
 Writer log)
              throws IOException

Throws:

IOException

Method Details

getId

public long getId()

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 LoggingWriter append(CharSequence csq)
                     throws IOException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

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

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

IOException

append

public LoggingWriter 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 LoggingResult 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