Package org.jline.terminal.impl

Class AbstractPosixTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.AbstractPosixTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, TerminalExt, Terminal

Direct Known Subclasses:

PosixPtyTerminal, PosixSysTerminal

public abstract class AbstractPosixTerminal
extends AbstractTerminal

Nested Class Summary

Nested classes/interfaces inherited from interface org.jline.terminal.Terminal

Terminal.MouseTracking, Terminal.Signal, Terminal.SignalHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final Attributes	originalAttributes
protected final Pty	pty

Fields inherited from class org.jline.terminal.impl.AbstractTerminal

bools, encoding, handlers, ints, name, onClose, palette, status, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

Constructor	Description
AbstractPosixTerminal(String name, String type, Pty pty)
AbstractPosixTerminal(String name, String type, Pty pty, Charset encoding, Terminal.SignalHandler signalHandler)

Method Summary

Modifier and Type	Method	Description
protected void	doClose()
Attributes	getAttributes()	Returns the terminal attributes.
Cursor	getCursorPosition(IntConsumer discarded)	Query the terminal to report the cursor position.
TerminalProvider	getProvider()	Returns the TerminalProvider that created this terminal or null if the terminal was created with no provider.
Pty	getPty()
Size	getSize()	Retrieve the size of the visible window
SystemStream	getSystemStream()	The underlying system stream, may be SystemStream.Output, SystemStream.Error, or null if this terminal is not bound to a system stream.
void	setAttributes(Attributes attr)	Set the terminal attributes.
void	setSize(Size size)

Methods inherited from class org.jline.terminal.impl.AbstractTerminal

canPauseResume, checkInterrupted, close, echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getKind, getName, getNumericCapability, getPalette, getStatus, getStatus, getStringCapability, getType, handle, hasFocusSupport, hasMouseSupport, parseInfoCmp, pause, pause, paused, puts, raise, readMouseEvent, readMouseEvent, resume, setOnClose, trackFocus, trackMouse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.terminal.Terminal

getBufferSize, getHeight, getWidth, input, output, reader, writer

Field Details

pty

protected final Pty pty

originalAttributes

protected final Attributes originalAttributes

Constructor Details

AbstractPosixTerminal

public AbstractPosixTerminal(String name,
 String type,
 Pty pty)
                      throws IOException

Throws:

IOException

AbstractPosixTerminal

public AbstractPosixTerminal(String name,
 String type,
 Pty pty,
 Charset encoding,
 Terminal.SignalHandler signalHandler)
                      throws IOException

Throws:

IOException

Method Details

getPty

public Pty getPty()

getAttributes

public Attributes getAttributes()

Description copied from interface: Terminal

Returns the terminal attributes. The returned object can be safely modified further used in a call to Terminal.setAttributes(Attributes).

Returns:

the terminal attributes.

setAttributes

public void setAttributes(Attributes attr)

Description copied from interface: Terminal

Set the terminal attributes. The terminal will perform a copy of the given attributes.

Parameters:

attr - the new attributes

getSize

public Size getSize()

Description copied from interface: Terminal

Retrieve the size of the visible window

Returns:

the visible terminal size

See Also:

• Terminal.getBufferSize()

setSize

public void setSize(Size size)

doClose

protected void doClose()
                throws IOException

Overrides:

doClose in class AbstractTerminal

Throws:

IOException

getCursorPosition

public Cursor getCursorPosition(IntConsumer discarded)

Description copied from interface: Terminal

Query the terminal to report the cursor position. As the response is read from the input stream, some characters may be read before the cursor position is actually read. Those characters can be given back using org.jline.keymap.BindingReader#runMacro(String)

Specified by:

getCursorPosition in interface Terminal

Overrides:

getCursorPosition in class AbstractTerminal

Parameters:

discarded - a consumer receiving discarded characters

Returns:

null if cursor position reporting is not supported or a valid cursor position

getProvider

public TerminalProvider getProvider()

Description copied from interface: TerminalExt

Returns the TerminalProvider that created this terminal or null if the terminal was created with no provider.

getSystemStream

public SystemStream getSystemStream()

Description copied from interface: TerminalExt

The underlying system stream, may be SystemStream.Output, SystemStream.Error, or null if this terminal is not bound to a system stream.