Package org.jline.terminal.impl.jni

Class JniTerminalProvider

java.lang.Object

org.jline.terminal.impl.jni.JniTerminalProvider

All Implemented Interfaces:

TerminalProvider

public class JniTerminalProvider
extends Object
implements TerminalProvider

Terminal provider implementation that uses JNI (Java Native Interface) to access native terminal functionality.

This provider requires the JLine native library to be loaded, which is handled by JLineNativeLoader. The native library provides access to low-level terminal operations that are not available through standard Java APIs.

The native library is automatically loaded when this provider is used. If the library cannot be loaded, the provider will not be available and JLine will fall back to other available providers.

The native library loading can be configured using system properties as documented in JLineNativeLoader.

See Also:

• JLineNativeLoader
• TerminalBuilder

Constructor Summary

Constructors

Constructor	Description
JniTerminalProvider()	Creates a new JNI terminal provider instance and ensures the native library is loaded.

Method Summary

Modifier and Type	Method	Description
Pty	current(SystemStream systemStream)
int	getConsoleCodepage()	Retrieve the Windows console output code page.
boolean	isPosixSystemStream(SystemStream stream)
boolean	isSystemStream(SystemStream stream)	Checks if the specified system stream is available on this platform.
boolean	isWindowsSystemStream(SystemStream stream)
String	name()	Returns the name of this terminal provider.
Terminal	newTerminal(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset inputEncoding, Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)	Create a new terminal backed by a newly opened POSIX pseudo-terminal (PTY).
Pty	open(Attributes attributes, Size size)
Terminal	posixSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	posixSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Create a POSIX system terminal backed by a native PTY.
String	systemStreamName(SystemStream stream)	Returns the name of the specified system stream on this platform.
int	systemStreamWidth(SystemStream stream)	Returns the width (number of columns) of the specified system stream.
Terminal	sysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset inputEncoding, Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Creates a terminal connected to a system stream.
String	toString()
Terminal	winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.terminal.spi.TerminalProvider

registerDefaultSignal, registerSignal, sysTerminal, unregisterSignal

Constructor Details

JniTerminalProvider

public JniTerminalProvider()

Creates a new JNI terminal provider instance and ensures the native library is loaded.

Loading the native library via JLineNativeLoader.initialize() calls System.loadLibrary(), which is a restricted operation. On JDK 24-25 this produces a JVM warning when --enable-native-access is not set. On future JDKs where native access is denied by default, the load will fail and TerminalBuilder will fall back to other providers.

Method Details

name

public String name()

Description copied from interface: TerminalProvider

Returns the name of this terminal provider.

The provider name is a unique identifier that can be used to request this specific provider when creating terminals. Common provider names include "ffm", "jni", "exec", and "dumb".

Specified by:

name in interface TerminalProvider

Returns:

the name of this terminal provider

getConsoleCodepage

public int getConsoleCodepage()

Description copied from interface: TerminalProvider

Retrieve the Windows console output code page. On Windows this returns the console output code page; on non-Windows platforms or when the code page cannot be determined this returns -1.

Specified by:

getConsoleCodepage in interface TerminalProvider

Returns:

the console output code page, or -1 if not available

current

public Pty current(SystemStream systemStream)
            throws IOException

Throws:

IOException

open

public Pty open(Attributes attributes,
 Size size)
         throws IOException

Throws:

IOException

sysTerminal

public Terminal sysTerminal(String name,
 String type,
 boolean ansiPassThrough,
 Charset encoding,
 Charset inputEncoding,
 Charset outputEncoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler,
 boolean paused,
 SystemStream systemStream)
                     throws IOException

Description copied from interface: TerminalProvider

Creates a terminal connected to a system stream.

This method creates a terminal that is connected to one of the standard system streams (standard input, standard output, or standard error). Such terminals typically represent the actual terminal window or console that the application is running in.

Specified by:

sysTerminal in interface TerminalProvider

Parameters:

name - the name of the terminal

type - the terminal type (e.g., "xterm", "dumb")

ansiPassThrough - whether to pass through ANSI escape sequences (only used on Windows)

encoding - the general character encoding to use

inputEncoding - the character encoding to use for input

outputEncoding - the character encoding to use for output

nativeSignals - whether to use native signal handling

signalHandler - the signal handler to use

paused - whether the terminal should start in a paused state (only used on Windows)

systemStream - the system stream to connect to

Returns:

a new terminal connected to the specified system stream

Throws:

IOException - if an I/O error occurs

winSysTerminal

public Terminal winSysTerminal(String name,
 String type,
 boolean ansiPassThrough,
 Charset encoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler,
 boolean paused,
 SystemStream systemStream)
                        throws IOException

Throws:

IOException

winSysTerminal

public Terminal winSysTerminal(String name,
 String type,
 boolean ansiPassThrough,
 Charset encoding,
 Charset stdinEncoding,
 Charset stdoutEncoding,
 Charset stderrEncoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler,
 boolean paused,
 SystemStream systemStream)
                        throws IOException

Throws:

IOException

posixSysTerminal

public Terminal posixSysTerminal(String name,
 String type,
 boolean ansiPassThrough,
 Charset encoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler,
 boolean paused,
 SystemStream systemStream)
                          throws IOException

Throws:

IOException

posixSysTerminal

public Terminal posixSysTerminal(String name,
 String type,
 boolean ansiPassThrough,
 Charset encoding,
 Charset stdinEncoding,
 Charset stdoutEncoding,
 Charset stderrEncoding,
 boolean nativeSignals,
 Terminal.SignalHandler signalHandler,
 boolean paused,
 SystemStream systemStream)
                          throws IOException

Create a POSIX system terminal backed by a native PTY. The created terminal is configured with the provided character encodings and signal handling. The output encoding is chosen from stdoutEncoding or stderrEncoding depending on systemStream.

Parameters:

name - human-readable terminal name

type - terminal type (TERM)

ansiPassThrough - ignored — ANSI pass-through is only supported on Windows

encoding - primary charset used by the terminal

stdinEncoding - charset for standard input

stdoutEncoding - charset for standard output

stderrEncoding - charset for standard error

nativeSignals - whether native signal handling is enabled

signalHandler - handler for terminal signals

paused - ignored — paused mode is only supported on Windows and PTY-backed terminals

systemStream - which system stream the terminal represents (affects output encoding selection)

Returns:

a POSIX system terminal

Throws:

IOException - if the underlying PTY cannot be opened

newTerminal

public Terminal newTerminal(String name,
 String type,
 InputStream in,
 OutputStream out,
 Charset encoding,
 Charset inputEncoding,
 Charset outputEncoding,
 Terminal.SignalHandler signalHandler,
 boolean paused,
 Attributes attributes,
 Size size)
                     throws IOException

Create a new terminal backed by a newly opened POSIX pseudo-terminal (PTY).

Specified by:

newTerminal in interface TerminalProvider

Parameters:

name - the terminal name for identification

type - the terminal type (TERM)

in - the input stream connected to the PTY slave

out - the output stream connected to the PTY slave

encoding - the primary charset for the terminal

inputEncoding - the charset to decode input

outputEncoding - the charset to encode output

signalHandler - handler for terminal signals

paused - if true, the terminal is created in a paused state

attributes - initial terminal attributes for the PTY

size - initial terminal size for the PTY

Returns:

a Terminal instance wrapping the opened PTY and provided streams

Throws:

IOException - if the PTY cannot be opened

isSystemStream

public boolean isSystemStream(SystemStream stream)

Description copied from interface: TerminalProvider

Checks if the specified system stream is available on this platform.

This method determines whether the specified system stream (standard input, standard output, or standard error) is available for use on the current platform. Some platforms or environments may restrict access to certain system streams.

Specified by:

isSystemStream in interface TerminalProvider

Parameters:

stream - the system stream to check

Returns:

true if the system stream is available, false otherwise

isWindowsSystemStream

public boolean isWindowsSystemStream(SystemStream stream)

isPosixSystemStream

public boolean isPosixSystemStream(SystemStream stream)

systemStreamName

public String systemStreamName(SystemStream stream)

Description copied from interface: TerminalProvider

Returns the name of the specified system stream on this platform.

This method returns a platform-specific name or identifier for the specified system stream. The name may be used for display purposes or for accessing the stream through platform-specific APIs.

Specified by:

systemStreamName in interface TerminalProvider

Parameters:

stream - the system stream

Returns:

the name of the system stream on this platform

systemStreamWidth

public int systemStreamWidth(SystemStream stream)

Description copied from interface: TerminalProvider

Returns the width (number of columns) of the specified system stream.

This method determines the width of the terminal associated with the specified system stream. The width is measured in character cells and represents the number of columns available for display.

Specified by:

systemStreamWidth in interface TerminalProvider

Parameters:

stream - the system stream

Returns:

the width of the system stream in character columns

toString

public String toString()

Overrides:

toString in class Object