Package org.jline.jansi.io

Class AnsiOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.jline.jansi.io.AnsiOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class AnsiOutputStream
extends FilterOutputStream

A ANSI print stream extracts ANSI escape codes written to an output stream and calls corresponding AnsiProcessor.process* methods. This particular class is not synchronized for improved performances.

For more information about ANSI escape codes, see Wikipedia article

Since:

1.0

See Also:

• AnsiProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnsiOutputStream.IoRunnable
static interface	AnsiOutputStream.WidthSupplier
static class	AnsiOutputStream.ZeroWidthSupplier

Field Summary

Fields

Modifier and Type	Field	Description
static final byte[]	RESET_CODE

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
AnsiOutputStream(OutputStream os, AnsiOutputStream.WidthSupplier width, AnsiMode mode, AnsiProcessor processor, AnsiType type, AnsiColors colors, Charset cs, AnsiOutputStream.IoRunnable installer, AnsiOutputStream.IoRunnable uninstaller, boolean resetAtUninstall)

Method Summary

Modifier and Type	Method	Description
void	close()
AnsiColors	getColors()
AnsiMode	getMode()
int	getTerminalWidth()
AnsiType	getType()
void	install()
boolean	isResetAtUninstall()
final void	setMode(AnsiMode mode)
void	setResetAtUninstall(boolean resetAtUninstall)
void	uninstall()
void	write(int data)

Methods inherited from class java.io.FilterOutputStream

flush, write, write

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Field Details

RESET_CODE

public static final byte[] RESET_CODE

Constructor Details

AnsiOutputStream

public AnsiOutputStream(OutputStream os,
 AnsiOutputStream.WidthSupplier width,
 AnsiMode mode,
 AnsiProcessor processor,
 AnsiType type,
 AnsiColors colors,
 Charset cs,
 AnsiOutputStream.IoRunnable installer,
 AnsiOutputStream.IoRunnable uninstaller,
 boolean resetAtUninstall)

Method Details

getTerminalWidth

public int getTerminalWidth()

getType

public AnsiType getType()

getColors

public AnsiColors getColors()

getMode

public AnsiMode getMode()

setMode

public final void setMode(AnsiMode mode)

isResetAtUninstall

public boolean isResetAtUninstall()

setResetAtUninstall

public void setResetAtUninstall(boolean resetAtUninstall)

write

public void write(int data)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

install

public void install()
             throws IOException

Throws:

IOException

uninstall

public void uninstall()
               throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException