org.terracotta.utilities.io

Class CapturedPrintStream.FileCapturedPrintStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

org.terracotta.utilities.io.CapturedPrintStream

org.terracotta.utilities.io.CapturedPrintStream.FileCapturedPrintStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

Enclosing class:

CapturedPrintStream

public static final class CapturedPrintStream.FileCapturedPrintStream
extends CapturedPrintStream

A PrintStream to capture to a file-backed buffer. The captured stream is available by calling getReader(). UTF-8 is used for encoding and decoding the stream content.

See Also:

CapturedPrintStream.getInstance(Path)

Nested Class Summary

Nested classes/interfaces inherited from class org.terracotta.utilities.io.CapturedPrintStream

CapturedPrintStream.FileCapturedPrintStream, CapturedPrintStream.MemoryCapturedPrintStream

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Method Summary

Modifier and Type	Method and Description
java.io.BufferedReader	getReader() Gets a BufferedReader over the bytes written to this PrintStream.
void	reset() Discards the captured output.
void	sync() Ensures all buffered content is flushed to disk.
byte[]	toByteArray() Gets a copy of the content of this stream as a byte array.

Methods inherited from class org.terracotta.utilities.io.CapturedPrintStream

append, append, append, checkError, close, flush, format, format, getInstance, getInstance, getInstance, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, write, write, write

Methods inherited from class java.io.PrintStream

clearError, setError

Methods inherited from class java.lang.Object

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

Method Detail

sync

public void sync()
          throws java.io.IOException

Ensures all buffered content is flushed to disk.

Throws:

java.io.IOException - if an error is raised from the FileDescriptor.sync() call

getReader

public java.io.BufferedReader getReader()

Gets a BufferedReader over the bytes written to this PrintStream. The content of this stream is not altered by this method.

This method calls CapturedPrintStream.flush() and FileDescriptor.sync() to ensure all captured output is available to the reader.

Specified by:

getReader in class CapturedPrintStream

Returns:

a new BufferedReader over the bytes written to this stream

Throws:

java.io.UncheckedIOException - for a CapturedPrintStream.FileCapturedPrintStream if an IOException is thrown when opening the file for reading

See Also:

CapturedPrintStream.reset()

reset

public void reset()

Discards the captured output.

This method closes the previous PrintStream delegate iff the new delegate is successfully created.

Specified by:

reset in class CapturedPrintStream

Throws:

java.io.UncheckedIOException - if an error is raised while opening the new delegate

toByteArray

public byte[] toByteArray()

Gets a copy of the content of this stream as a byte array. The content of this stream is not altered by this method.

This method calls CapturedPrintStream.flush() and FileDescriptor.sync() to ensure all captured output is available to the reader.

Specified by:

toByteArray in class CapturedPrintStream

Returns:

a byte array containing a copy of the captured data

Throws:

java.io.UncheckedIOException - if an error is raised while reading the backing file

See Also:

CapturedPrintStream.reset()