org.jline.terminal.impl

Class PosixPtyTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.AbstractPosixTerminal

org.jline.terminal.impl.PosixPtyTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Terminal

public class PosixPtyTerminal
extends AbstractPosixTerminal

Nested Class Summary

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

Terminal.MouseTracking, Terminal.Signal, Terminal.SignalHandler

Field Summary

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

originalAttributes, pty

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

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

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

Constructor and Description
PosixPtyTerminal(String name, String type, Pty pty, InputStream in, OutputStream out, Charset encoding)
PosixPtyTerminal(String name, String type, Pty pty, InputStream in, OutputStream out, Charset encoding, Terminal.SignalHandler signalHandler)
PosixPtyTerminal(String name, String type, Pty pty, InputStream in, OutputStream out, Charset encoding, Terminal.SignalHandler signalHandler, boolean paused)

Method Summary

Modifier and Type	Method and Description
boolean	canPauseResume() Whether this terminal supports Terminal.pause() and Terminal.resume() calls.
void	close()
InputStream	input() Retrieve the input stream for this terminal.
OutputStream	output() Retrieve the output stream for this terminal.
void	pause() Stop reading the input stream.
void	pause(boolean wait) Stop reading the input stream and optionally wait for the underlying threads to finish.
boolean	paused() Check whether the terminal is currently reading the input stream or not.
NonBlockingReader	reader() Retrieve the Reader for this terminal.
void	resume() Resume reading the input stream.
PrintWriter	writer() Retrieve the Writer for this terminal.

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

getAttributes, getCursorPosition, getPty, getSize, setAttributes, setSize

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

checkInterrupted, echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getKind, getName, getNumericCapability, getStatus, getStatus, getStringCapability, getType, handle, hasFocusSupport, hasMouseSupport, parseInfoCmp, puts, raise, readMouseEvent, readMouseEvent, 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

getHeight, getWidth

Constructor Detail

PosixPtyTerminal

public PosixPtyTerminal(String name,
                        String type,
                        Pty pty,
                        InputStream in,
                        OutputStream out,
                        Charset encoding)
                 throws IOException

Throws:

IOException

PosixPtyTerminal

public PosixPtyTerminal(String name,
                        String type,
                        Pty pty,
                        InputStream in,
                        OutputStream out,
                        Charset encoding,
                        Terminal.SignalHandler signalHandler)
                 throws IOException

Throws:

IOException

PosixPtyTerminal

public PosixPtyTerminal(String name,
                        String type,
                        Pty pty,
                        InputStream in,
                        OutputStream out,
                        Charset encoding,
                        Terminal.SignalHandler signalHandler,
                        boolean paused)
                 throws IOException

Throws:

IOException

Method Detail

input

public InputStream input()

Description copied from interface: Terminal

Retrieve the input stream for this terminal. In some rare cases, there may be a need to access the terminal input stream directly. In the usual cases, use the Terminal.reader() instead.

Returns:

The input stream

See Also:

Terminal.reader()

reader

public NonBlockingReader reader()

Description copied from interface: Terminal

Retrieve the Reader for this terminal. This is the standard way to read input from this terminal. The reader is non blocking.

Returns:

The non blocking reader

output

public OutputStream output()

Description copied from interface: Terminal

Retrieve the output stream for this terminal. In some rare cases, there may be a need to access the terminal output stream directly. In the usual cases, use the Terminal.writer() instead.

Returns:

The output stream

See Also:

Terminal.writer();

writer

public PrintWriter writer()

Description copied from interface: Terminal

Retrieve the Writer for this terminal. This is the standard way to write to this terminal.

Returns:

The writer

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractPosixTerminal

Throws:

IOException

canPauseResume

public boolean canPauseResume()

Description copied from interface: Terminal

Whether this terminal supports Terminal.pause() and Terminal.resume() calls.

Specified by:

canPauseResume in interface Terminal

Overrides:

canPauseResume in class AbstractTerminal

Returns:

whether this terminal supports Terminal.pause() and Terminal.resume() calls.

See Also:

Terminal.paused(), Terminal.pause(), Terminal.resume()

pause

public void pause()

Description copied from interface: Terminal

Stop reading the input stream.

Specified by:

pause in interface Terminal

Overrides:

pause in class AbstractTerminal

See Also:

Terminal.resume(), Terminal.paused()

pause

public void pause(boolean wait)
           throws InterruptedException

Description copied from interface: Terminal

Stop reading the input stream and optionally wait for the underlying threads to finish.

Specified by:

pause in interface Terminal

Overrides:

pause in class AbstractTerminal

Parameters:

wait - true to wait until the terminal is actually paused

Throws:

InterruptedException - if the call has been interrupted

resume

public void resume()

Description copied from interface: Terminal

Resume reading the input stream.

Specified by:

resume in interface Terminal

Overrides:

resume in class AbstractTerminal

See Also:

Terminal.pause(), Terminal.paused()

paused

public boolean paused()

Description copied from interface: Terminal

Check whether the terminal is currently reading the input stream or not. In order to process signal as quickly as possible, the terminal need to read the input stream and buffer it internally so that it can detect specific characters in the input stream (Ctrl+C, Ctrl+D, etc...) and raise the appropriate signals. However, there are some cases where this processing should be disabled, for example when handing the terminal control to a subprocess.

Specified by:

paused in interface Terminal

Overrides:

paused in class AbstractTerminal

Returns:

whether the terminal is currently reading the input stream or not

See Also:

Terminal.pause(), Terminal.resume()