Class AnsiOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.PrintStream

com.github.rvesse.airline.io.output.AnsiOutputStream

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

ColorizedOutputStream

public abstract class AnsiOutputStream
extends PrintStream

An output stream that supports customized output via ANSI control codes

Field Summary

Fields

Modifier and Type	Field	Description
private final List<OutputStreamControlTracker>	controls

Fields inherited from class FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
AnsiOutputStream(OutputStream output)

Method Summary

Modifier and Type	Method	Description
protected final void	applyAll()	Method which applies any necessary controls to the stream
void	close()
final void	registerControl(OutputStreamControlTracker control)	Registers a control
final void	registerControls(OutputStreamControlTracker... controls)	Registers some controls
void	reset(boolean full)	Resets the stream to the default state i.e.
protected final void	resetAll()	Method which resets the state of any controls that have been previously enabled and applied to the stream
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class PrintStream

append, append, append, charset, checkError, clearError, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, writeBytes

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Field Details

controls

private final List<OutputStreamControlTracker> controls

Constructor Details

AnsiOutputStream

public AnsiOutputStream(OutputStream output)

Method Details

registerControl

public final void registerControl(OutputStreamControlTracker control)

Registers a control

This method can be useful if you wish to add additional controls beyond those provided by a specific class derived from this abstract class.

Parameters:

control - Control

registerControls

public final void registerControls(OutputStreamControlTracker... controls)

Registers some controls

Parameters:

controls - Controls

write

public void write(int b)

Overrides:

write in class PrintStream

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class PrintStream

Throws:

IOException

write

public void write(byte[] b,
 int off,
 int len)

Overrides:

write in class PrintStream

applyAll

protected final void applyAll()

Method which applies any necessary controls to the stream

reset

public void reset(boolean full)

Resets the stream to the default state i.e. disables all controls that may previously have been applied such as colors, text decorations etc

Parameters:

full - If true do a full graphics reset in addition to resetting the individual controls

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class PrintStream

resetAll

protected final void resetAll()

Method which resets the state of any controls that have been previously enabled and applied to the stream