Class JniTerminalProvider
- All Implemented Interfaces:
TerminalProvider
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:
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new JNI terminal provider instance and ensures the native library is loaded. -
Method Summary
Modifier and TypeMethodDescriptioncurrent
(SystemStream systemStream) boolean
isPosixSystemStream
(SystemStream stream) boolean
isSystemStream
(SystemStream stream) Checks if the specified system stream is available on this platform.boolean
isWindowsSystemStream
(SystemStream stream) name()
Returns the name of this terminal provider.newTerminal
(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) Creates a new terminal with custom input and output streams.open
(Attributes attributes, Size size) posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) posixSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) 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.sysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) Creates a terminal connected to a system stream.toString()
winSysTerminal
(String name, String type, boolean ansiPassThrough, Charset encoding, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused, SystemStream systemStream) 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
newTerminal, sysTerminal
-
Constructor Details
-
JniTerminalProvider
public JniTerminalProvider()Creates a new JNI terminal provider instance and ensures the native library is loaded.The constructor initializes the JLine native library using
JLineNativeLoader.initialize()
. If the native library cannot be loaded, methods in this provider may throw exceptions when used.
-
-
Method Details
-
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 interfaceTerminalProvider
- Returns:
- the name of this terminal provider
-
current
- Throws:
IOException
-
open
- Throws:
IOException
-
sysTerminal
public Terminal sysTerminal(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 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 interfaceTerminalProvider
- Parameters:
name
- the name of the terminaltype
- the terminal type (e.g., "xterm", "dumb")ansiPassThrough
- whether to pass through ANSI escape sequencesencoding
- the general character encoding to usestdinEncoding
- the character encoding to use for standard inputstdoutEncoding
- the character encoding to use for standard outputstderrEncoding
- the character encoding to use for standard errornativeSignals
- whether to use native signal handlingsignalHandler
- the signal handler to usepaused
- whether the terminal should start in a paused statesystemStream
- 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 - Throws:
IOException
-
newTerminal
public Terminal newTerminal(String name, String type, InputStream in, OutputStream out, Charset encoding, Charset stdinEncoding, Charset stdoutEncoding, Charset stderrEncoding, Terminal.SignalHandler signalHandler, boolean paused, Attributes attributes, Size size) throws 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 interfaceTerminalProvider
- Parameters:
name
- the name of the terminaltype
- the terminal type (e.g., "xterm", "dumb")in
- the input stream to read fromout
- the output stream to write toencoding
- the general character encoding to usestdinEncoding
- the character encoding to use for standard inputstdoutEncoding
- the character encoding to use for standard outputstderrEncoding
- the character encoding to use for standard errorsignalHandler
- the signal handler to usepaused
- whether the terminal should start in a paused stateattributes
- the initial terminal attributessize
- the initial terminal size- Returns:
- a new terminal connected to the specified streams
- Throws:
IOException
- if an I/O error occurs
-
isSystemStream
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 interfaceTerminalProvider
- Parameters:
stream
- the system stream to check- Returns:
true
if the system stream is available,false
otherwise
-
isWindowsSystemStream
-
isPosixSystemStream
-
systemStreamName
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 interfaceTerminalProvider
- Parameters:
stream
- the system stream- Returns:
- the name of the system stream on this platform
-
systemStreamWidth
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 interfaceTerminalProvider
- Parameters:
stream
- the system stream- Returns:
- the width of the system stream in character columns
-
toString
-