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 java.lang.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()	Returns the Windows console output codepage.
boolean	isPosixSystemStream(SystemStream stream)
boolean	isSystemStream(SystemStream stream)	Checks if the specified system stream is available on this platform.
boolean	isWindowsSystemStream(SystemStream stream)
java.lang.String	name()	Returns the name of this terminal provider.
Terminal	newTerminal(java.lang.String name, java.lang.String type, java.io.InputStream in, java.io.OutputStream out, java.nio.charset.Charset encoding, java.nio.charset.Charset stdinEncoding, java.nio.charset.Charset stdoutEncoding, java.nio.charset.Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)	Deprecated.
Terminal	newTerminal(java.lang.String name, java.lang.String type, java.io.InputStream in, java.io.OutputStream out, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size)	Creates a new terminal with custom input and output streams.
Pty	open(Attributes attributes, Size size)
Terminal	posixSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	posixSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset stdinEncoding, java.nio.charset.Charset stdoutEncoding, java.nio.charset.Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
java.lang.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(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset inputEncoding, java.nio.charset.Charset outputEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Creates a terminal connected to a system stream.
Terminal	sysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset stdinEncoding, java.nio.charset.Charset stdoutEncoding, java.nio.charset.Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)	Deprecated.
java.lang.String	toString()
Terminal	winSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream)
Terminal	winSysTerminal(java.lang.String name, java.lang.String type, boolean ansiPassThrough, java.nio.charset.Charset encoding, java.nio.charset.Charset stdinEncoding, java.nio.charset.Charset stdoutEncoding, java.nio.charset.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

newTerminal, sysTerminal

Constructor Detail

JniTerminalProvider

public JniTerminalProvider()

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

The constructor first checks that native access is enabled for this module. On JDK 22+, calling System.load() without --enable-native-access produces a warning (JDK 24+) or throws IllegalCallerException (JDK 26+). By checking upfront, this provider fails cleanly and allows TerminalBuilder to fall back to other providers.

Throws:

java.lang.UnsupportedOperationException - if native access is not enabled for this module

Method Detail

name

public java.lang.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", "jansi", "jna", "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

Returns the Windows console output codepage.

On Windows, this method returns the console output codepage (equivalent to GetConsoleOutputCP()). On non-Windows platforms, or if the codepage cannot be determined, this method returns -1.

Specified by:

getConsoleCodepage in interface TerminalProvider

Returns:

the console output codepage, or -1 if not available

current

public Pty current(SystemStream systemStream)
            throws java.io.IOException

Throws:

java.io.IOException

open

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

Throws:

java.io.IOException

sysTerminal

public Terminal sysTerminal(java.lang.String name,
                            java.lang.String type,
                            boolean ansiPassThrough,
                            java.nio.charset.Charset encoding,
                            java.nio.charset.Charset inputEncoding,
                            java.nio.charset.Charset outputEncoding,
                            boolean nativeSignals,
                            Terminal.SignalHandler signalHandler,
                            boolean paused,
                            SystemStream systemStream)
                     throws java.io.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

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

systemStream - the system stream to connect to

Returns:

a new terminal connected to the specified system stream

Throws:

java.io.IOException - if an I/O error occurs

sysTerminal

@Deprecated
public Terminal sysTerminal(java.lang.String name,
                            java.lang.String type,
                            boolean ansiPassThrough,
                            java.nio.charset.Charset encoding,
                            java.nio.charset.Charset stdinEncoding,
                            java.nio.charset.Charset stdoutEncoding,
                            java.nio.charset.Charset stderrEncoding,
                            boolean nativeSignals,
                            Terminal.SignalHandler signalHandler,
                            boolean paused,
                            SystemStream systemStream)
                     throws java.io.IOException

Deprecated.

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

encoding - the general character encoding to use

stdinEncoding - the character encoding to use for standard input

stdoutEncoding - the character encoding to use for standard output

stderrEncoding - the character encoding to use for standard error

nativeSignals - whether to use native signal handling

signalHandler - the signal handler to use

paused - whether the terminal should start in a paused state

systemStream - the system stream to connect to

Returns:

a new terminal connected to the specified system stream

Throws:

java.io.IOException - if an I/O error occurs

winSysTerminal

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

Throws:

java.io.IOException

winSysTerminal

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

Throws:

java.io.IOException

posixSysTerminal

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

Throws:

java.io.IOException

posixSysTerminal

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

Throws:

java.io.IOException

newTerminal

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

Description copied from interface: TerminalProvider

Creates a new terminal with custom input and output streams.

This method creates a terminal that is connected to the specified input and output streams. Such terminals can be used for various purposes, such as connecting to remote terminals over network connections or creating virtual terminals for testing.

Specified by:

newTerminal in interface TerminalProvider

Parameters:

name - the name of the terminal

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

in - the input stream to read from

out - the output stream to write to

encoding - the general character encoding to use

inputEncoding - the character encoding to use for input

outputEncoding - the character encoding to use for output

signalHandler - the signal handler to use

paused - whether the terminal should start in a paused state

attributes - the initial terminal attributes

size - the initial terminal size

Returns:

a new terminal connected to the specified streams

Throws:

java.io.IOException - if an I/O error occurs

newTerminal

@Deprecated
public Terminal newTerminal(java.lang.String name,
                            java.lang.String type,
                            java.io.InputStream in,
                            java.io.OutputStream out,
                            java.nio.charset.Charset encoding,
                            java.nio.charset.Charset stdinEncoding,
                            java.nio.charset.Charset stdoutEncoding,
                            java.nio.charset.Charset stderrEncoding,
                            Terminal.SignalHandler signalHandler,
                            boolean paused,
                            Attributes attributes,
                            Size size)
                     throws java.io.IOException

Deprecated.

Description copied from interface: TerminalProvider

Creates a new terminal with custom input and output streams.

This method creates a terminal that is connected to the specified input and output streams. Such terminals can be used for various purposes, such as connecting to remote terminals over network connections or creating virtual terminals for testing.

Specified by:

newTerminal in interface TerminalProvider

Parameters:

name - the name of the terminal

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

in - the input stream to read from

out - the output stream to write to

encoding - the general character encoding to use

stdinEncoding - the character encoding to use for standard input

stdoutEncoding - the character encoding to use for standard output

stderrEncoding - the character encoding to use for standard error

signalHandler - the signal handler to use

paused - whether the terminal should start in a paused state

attributes - the initial terminal attributes

size - the initial terminal size

Returns:

a new terminal connected to the specified streams

Throws:

java.io.IOException - if an I/O error occurs

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 java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object