Top Description Inners Fields Constructors Methods
org.fusesource.jansi.io

public Class AnsiOutputStream

extends FilterOutputStream
Class Inheritance
Imports
java.io.FilterOutputStream, .IOException, .OutputStream, java.nio.charset.Charset, java.util.ArrayList, org.fusesource.jansi.AnsiColors, .AnsiMode, .AnsiType

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 and Inner Type Summary

Modifier and TypeClass and Description
public static interface
public static interface
public static class

Field Summary

Modifier and TypeField and Description
private AnsiProcessor
private static final int
private final byte[]
private final AnsiColors
private final Charset
private static final int
private final AnsiOutputStream.IoRunnable
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private AnsiMode
private final ArrayList<Object>
private int
private final AnsiProcessor
public static final byte[]
private boolean
private static final int
private static final int
private static final int
private static final int
private static final int
private int
private int
private final AnsiType
private final AnsiOutputStream.IoRunnable
private final AnsiOutputStream.WidthSupplier
Inherited from java.io.FilterOutputStream:
out

Constructor Summary

AccessConstructor and Description
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 Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with the stream.
public AnsiColors
public AnsiMode
public int
public AnsiType
public void
public boolean
private void
private void
private void
private void
reset(boolean
if current buffer should be skipped or written to out
skipBuffer
)

Resets all state to continue with regular parsing

public void
public void
setResetAtUninstall(boolean resetAtUninstall)

public void
public void
write(int
the byte.
data
)

Overrides java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.
Inherited from java.io.FilterOutputStream:
flushwritewrite

Field Detail

apback to summary
private AnsiProcessor ap
BELback to summary
private static final int BEL
bufferback to summary
private final byte[] buffer
colorsback to summary
private final AnsiColors colors
csback to summary
private final Charset cs
FIRST_ESC_CHARback to summary
private static final int FIRST_ESC_CHAR
installerback to summary
private final AnsiOutputStream.IoRunnable installer
LOOKING_FOR_CHARSETback to summary
private static final int LOOKING_FOR_CHARSET
LOOKING_FOR_FIRST_ESC_CHARback to summary
private static final int LOOKING_FOR_FIRST_ESC_CHAR
LOOKING_FOR_INT_ARG_ENDback to summary
private static final int LOOKING_FOR_INT_ARG_END
LOOKING_FOR_NEXT_ARGback to summary
private static final int LOOKING_FOR_NEXT_ARG
LOOKING_FOR_OSC_COMMANDback to summary
private static final int LOOKING_FOR_OSC_COMMAND
LOOKING_FOR_OSC_COMMAND_ENDback to summary
private static final int LOOKING_FOR_OSC_COMMAND_END
LOOKING_FOR_OSC_PARAMback to summary
private static final int LOOKING_FOR_OSC_PARAM
LOOKING_FOR_SECOND_ESC_CHARback to summary
private static final int LOOKING_FOR_SECOND_ESC_CHAR
LOOKING_FOR_STback to summary
private static final int LOOKING_FOR_ST
LOOKING_FOR_STR_ARG_ENDback to summary
private static final int LOOKING_FOR_STR_ARG_END
MAX_ESCAPE_SEQUENCE_LENGTHback to summary
private static final int MAX_ESCAPE_SEQUENCE_LENGTH
modeback to summary
private AnsiMode mode
optionsback to summary
private final ArrayList<Object> options
posback to summary
private int pos
processorback to summary
private final AnsiProcessor processor
RESET_CODEback to summary
public static final byte[] RESET_CODE
resetAtUninstallback to summary
private boolean resetAtUninstall
SECOND_CHARSET0_CHARback to summary
private static final int SECOND_CHARSET0_CHAR
SECOND_CHARSET1_CHARback to summary
private static final int SECOND_CHARSET1_CHAR
SECOND_ESC_CHARback to summary
private static final int SECOND_ESC_CHAR
SECOND_OSC_CHARback to summary
private static final int SECOND_OSC_CHAR
SECOND_ST_CHARback to summary
private static final int SECOND_ST_CHAR
startOfValueback to summary
private int startOfValue
stateback to summary
private int state
typeback to summary
private final AnsiType type
uninstallerback to summary
private final AnsiOutputStream.IoRunnable uninstaller
widthback to summary
private final AnsiOutputStream.WidthSupplier width

Constructor Detail

AnsiOutputStreamback to summary
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 Detail

closeback to summary
public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterOutputStream.close.

Closes this output stream and releases any system resources associated with the stream.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
getColorsback to summary
public AnsiColors getColors()
getModeback to summary
public AnsiMode getMode()
getTerminalWidthback to summary
public int getTerminalWidth()
getTypeback to summary
public AnsiType getType()
installback to summary
public void install() throws IOException
isResetAtUninstallback to summary
public boolean isResetAtUninstall()
processCharsetSelectback to summary
private void processCharsetSelect() throws IOException
processEscapeCommandback to summary
private void processEscapeCommand(int data) throws IOException
processOperatingSystemCommandback to summary
private void processOperatingSystemCommand() throws IOException
resetback to summary
private void reset(boolean skipBuffer) throws IOException

Resets all state to continue with regular parsing

Parameters
skipBuffer:boolean

if current buffer should be skipped or written to out

setModeback to summary
public void setMode(AnsiMode mode)
setResetAtUninstallback to summary
public void setResetAtUninstall(boolean resetAtUninstall)
uninstallback to summary
public void uninstall() throws IOException
writeback to summary
public void write(int data) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.

Parameters
data:int

the byte.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
org.fusesource.jansi.io back to summary

public Interface AnsiOutputStream.IoRunnable

Annotations
@FunctionalInterface

Method Summary

Modifier and TypeMethod and Description
public void
run()

Method Detail

runback to summary
public void run() throws IOException
org.fusesource.jansi.io back to summary

public Interface AnsiOutputStream.WidthSupplier

Known Direct Implementers
org.fusesource.jansi.io.AnsiOutputStream.ZeroWidthSupplier
Annotations
@FunctionalInterface

Method Summary

Modifier and TypeMethod and Description
public int

Method Detail

getTerminalWidthback to summary
public int getTerminalWidth()
org.fusesource.jansi.io back to summary

public Class AnsiOutputStream.ZeroWidthSupplier

extends Object
implements WidthSupplier
Class Inheritance
All Implemented Interfaces
org.fusesource.jansi.io.AnsiOutputStream.WidthSupplier

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public int
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ZeroWidthSupplierback to summary
public ZeroWidthSupplier()

Method Detail

getTerminalWidthback to summary
public int getTerminalWidth()

Implements org.fusesource.jansi.io.AnsiOutputStream.WidthSupplier.getTerminalWidth.

Annotations
@Override