CapturedPrintStream (terracotta-utilities-tools 0.0.19 API)

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
  - - java.io.PrintStream
    - - org.terracotta.utilities.io.CapturedPrintStream

All Implemented Interfaces:

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

Direct Known Subclasses:

CapturedPrintStream.FileCapturedPrintStream, CapturedPrintStream.MemoryCapturedPrintStream
```
public abstract class CapturedPrintStream
extends java.io.PrintStream
```
Extends PrintStream to capture the output to an in-memory or file-backed buffer. The captured stream is available by calling getReader(). UTF-8 is used for encoding and decoding the stream content.

See Also:

getInstance(), getInstance(Path), getInstance(Path, boolean)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CapturedPrintStream.FileCapturedPrintStream` A `PrintStream` to capture to a file-backed buffer.
`static class`	`CapturedPrintStream.MemoryCapturedPrintStream` A `PrintStream` to capture to a memory-based buffer.

Field Summary
- Fields inherited from class java.io.FilterOutputStream
  out

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.io.PrintStream`	`append(char c)`
`java.io.PrintStream`	`append(java.lang.CharSequence csq)`
`java.io.PrintStream`	`append(java.lang.CharSequence csq, int start, int end)`
`boolean`	`checkError()`
`void`	`close()`
`void`	`flush()`
`java.io.PrintStream`	`format(java.util.Locale l, java.lang.String format, java.lang.Object... args)`
`java.io.PrintStream`	`format(java.lang.String format, java.lang.Object... args)`
`static CapturedPrintStream`	`getInstance()` Instantiates a new `CapturedPrintStream` using an in-memory buffer.
`static CapturedPrintStream`	`getInstance(java.nio.file.Path filePath)` Instantiates a new `CapturedPrintStream` using file as a buffer and auto-flush enabled.
`static CapturedPrintStream`	`getInstance(java.nio.file.Path filePath, boolean autoFlush)` Instantiates a new `CapturedPrintStream` using file as a buffer and a caller-specified auto-flush setting.
`abstract java.io.BufferedReader`	`getReader()` Gets a `BufferedReader` over the bytes written to this `PrintStream`.
`void`	`print(boolean b)`
`void`	`print(char c)`
`void`	`print(char[] s)`
`void`	`print(double d)`
`void`	`print(float f)`
`void`	`print(int i)`
`void`	`print(long l)`
`void`	`print(java.lang.Object obj)`
`void`	`print(java.lang.String s)`
`java.io.PrintStream`	`printf(java.util.Locale l, java.lang.String format, java.lang.Object... args)`
`java.io.PrintStream`	`printf(java.lang.String format, java.lang.Object... args)`
`void`	`println()`
`void`	`println(boolean x)`
`void`	`println(char x)`
`void`	`println(char[] x)`
`void`	`println(double x)`
`void`	`println(float x)`
`void`	`println(int x)`
`void`	`println(long x)`
`void`	`println(java.lang.Object x)`
`void`	`println(java.lang.String x)`
`abstract void`	`reset()` Discards the captured output.
`abstract byte[]`	`toByteArray()` Gets a copy of the content of this stream as a byte array.
`void`	`write(byte[] b)`
`void`	`write(byte[] buf, int off, int len)`
`void`	`write(int b)`

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
  - getInstance
```
public static CapturedPrintStream getInstance(java.nio.file.Path filePath,
                                              boolean autoFlush)
                                       throws java.io.IOException
```
    Instantiates a new CapturedPrintStream using file as a buffer and a caller-specified auto-flush setting.
    
    Parameters:
    
    filePath - Path to file used to capture stream output
    
    autoFlush - true enables auto-flushing of the capture PrintStream; false disables auto-flushing of the capture PrintStream
    
    Returns:
    
    a new CapturedPrintStream
    
    Throws:
    
    java.io.IOException - if an error is raised opening an output stream over filePath
    
    See Also:
    
    PrintStream(OutputStream, boolean, String)
  - getInstance
```
public static CapturedPrintStream getInstance(java.nio.file.Path filePath)
                                       throws java.io.IOException
```
    Instantiates a new CapturedPrintStream using file as a buffer and auto-flush enabled.
    This method is equivalent to
```
 CapturedPrintStream.getInstance(filePath, true)
```
    Parameters:
    
    filePath - Path to file used to capture stream output
    
    Returns:
    
    a new CapturedPrintStream
    
    Throws:
    
    java.io.IOException - if an error is raised opening an output stream over filePath
  - getInstance
```
public static CapturedPrintStream getInstance()
```
    Instantiates a new CapturedPrintStream using an in-memory buffer.
    
    Returns:
    
    a new CapturedPrintStream
  - getReader
```
public abstract 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.
    
    Returns:
    
    a new BufferedReader over the bytes written to this stream
    
    See Also:
    
    reset()
  - reset
```
public abstract void reset()
```
    Discards the captured output.
  - toByteArray
```
public abstract 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.
    
    Returns:
    
    a byte array containing a copy of the captured data
    
    See Also:
    
    reset()
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface java.io.Flushable
    
    Overrides:
    
    flush in class java.io.PrintStream
  - close
```
public void close()
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.PrintStream
  - checkError
```
public boolean checkError()
```
    Overrides:
    
    checkError in class java.io.PrintStream
  - write
```
public void write(int b)
```
    Overrides:
    
    write in class java.io.PrintStream
  - write
```
public void write(byte[] buf,
                  int off,
                  int len)
```
    Overrides:
    
    write in class java.io.PrintStream
  - print
```
public void print(boolean b)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(char c)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(int i)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(long l)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(float f)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(double d)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(char[] s)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(java.lang.String s)
```
    Overrides:
    
    print in class java.io.PrintStream
  - print
```
public void print(java.lang.Object obj)
```
    Overrides:
    
    print in class java.io.PrintStream
  - println
```
public void println()
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(boolean x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(char x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(int x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(long x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(float x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(double x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(char[] x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(java.lang.String x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - println
```
public void println(java.lang.Object x)
```
    Overrides:
    
    println in class java.io.PrintStream
  - printf
```
public java.io.PrintStream printf(java.lang.String format,
                                  java.lang.Object... args)
```
    Overrides:
    
    printf in class java.io.PrintStream
  - printf
```
public java.io.PrintStream printf(java.util.Locale l,
                                  java.lang.String format,
                                  java.lang.Object... args)
```
    Overrides:
    
    printf in class java.io.PrintStream
  - format
```
public java.io.PrintStream format(java.lang.String format,
                                  java.lang.Object... args)
```
    Overrides:
    
    format in class java.io.PrintStream
  - format
```
public java.io.PrintStream format(java.util.Locale l,
                                  java.lang.String format,
                                  java.lang.Object... args)
```
    Overrides:
    
    format in class java.io.PrintStream
  - append
```
public java.io.PrintStream append(java.lang.CharSequence csq)
```
    Specified by:
    
    append in interface java.lang.Appendable
    
    Overrides:
    
    append in class java.io.PrintStream
  - append
```
public java.io.PrintStream append(java.lang.CharSequence csq,
                                  int start,
                                  int end)
```
    Specified by:
    
    append in interface java.lang.Appendable
    
    Overrides:
    
    append in class java.io.PrintStream
  - append
```
public java.io.PrintStream append(char c)
```
    Specified by:
    
    append in interface java.lang.Appendable
    
    Overrides:
    
    append in class java.io.PrintStream
  - write
```
public void write(byte[] b)
           throws java.io.IOException
```
    Overrides:
    
    write in class java.io.FilterOutputStream
    
    Throws:
    
    java.io.IOException

Class CapturedPrintStream

Nested Class Summary

Field Summary

Fields inherited from class java.io.FilterOutputStream

Method Summary

Methods inherited from class java.io.PrintStream

Methods inherited from class java.lang.Object

Method Detail

getInstance

getInstance

getInstance

getReader

reset

toByteArray

flush

close

checkError

write

write

print

print

print

print

print

print

print

print

print

println

println

println

println

println

println

println

println

println

println

printf

printf

format

format

append

append

append

write