Class TerminalBuilder
- java.lang.Object
-
- org.jline.terminal.TerminalBuilder
-
public final class TerminalBuilder extends java.lang.Object
Builder class to createTerminal
instances with flexible configuration options.TerminalBuilder provides a fluent API for creating and configuring terminals with various characteristics. It supports multiple implementation providers and handles the complexities of terminal creation across different platforms and environments.
Terminal Providers
JLine supports multiple terminal provider implementations:
- FFM - Foreign Function Memory (Java 22+) based implementation
- JNI - Java Native Interface based implementation
- Jansi - Implementation based on the Jansi library
- JNA - Java Native Access based implementation
- Exec - Implementation using external commands
- Dumb - Fallback implementation with limited capabilities
The provider selection can be controlled using the
provider(String)
method or theorg.jline.terminal.provider
system property. By default, providers are tried in the order: FFM, JNI, Jansi, JNA, Exec.Native Library Support
When using providers that require native libraries (such as JNI, JNA, or Jansi), the appropriate native library will be loaded automatically. The loading of these libraries is handled by
JLineNativeLoader
for the JNI provider.The native library loading can be configured using system properties as documented in
JLineNativeLoader
.System vs. Non-System Terminals
TerminalBuilder can create two types of terminals:
- System terminals - Connected to the actual system input/output streams
- Non-system terminals - Connected to custom input/output streams
System terminals are created using
system(boolean)
with a value oftrue
, while non-system terminals require specifying input and output streams usingstreams(InputStream, OutputStream)
.Usage Examples
Creating a default system terminal:
Terminal terminal = TerminalBuilder.builder() .system(true) .build();
Creating a terminal with custom streams:
Terminal terminal = TerminalBuilder.builder() .name("CustomTerminal") .streams(inputStream, outputStream) .encoding(StandardCharsets.UTF_8) .build();
Creating a terminal with a specific provider:
Terminal terminal = TerminalBuilder.builder() .system(true) .provider("jni") .build();
Creating a dumb terminal (with limited capabilities):
Terminal terminal = TerminalBuilder.builder() .dumb(true) .build();
- See Also:
Terminal
,JLineNativeLoader
,TerminalProvider
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TerminalBuilder.SystemOutput
-
Field Summary
Fields Modifier and Type Field Description static java.util.Set<java.lang.String>
DEPRECATED_PROVIDERS
static java.lang.String
PROP_CODEPAGE
static java.lang.String
PROP_COLOR_DISTANCE
static java.lang.String
PROP_DISABLE_ALTERNATE_CHARSET
static java.lang.String
PROP_DISABLE_DEPRECATED_PROVIDER_WARNING
static java.lang.String
PROP_DUMB
static java.lang.String
PROP_DUMB_COLOR
static java.lang.String
PROP_ENCODING
static java.lang.String
PROP_EXEC
static java.lang.String
PROP_FFM
static java.lang.String
PROP_FILE_DESCRIPTOR_CREATION_MODE
static java.lang.String
PROP_FILE_DESCRIPTOR_CREATION_MODE_DEFAULT
static java.lang.String
PROP_FILE_DESCRIPTOR_CREATION_MODE_NATIVE
static java.lang.String
PROP_FILE_DESCRIPTOR_CREATION_MODE_REFLECTION
static java.lang.String
PROP_JANSI
static java.lang.String
PROP_JNA
static java.lang.String
PROP_JNI
static java.lang.String
PROP_NON_BLOCKING_READS
static java.lang.String
PROP_OUTPUT
static java.lang.String
PROP_OUTPUT_ERR
static java.lang.String
PROP_OUTPUT_ERR_OUT
static java.lang.String
PROP_OUTPUT_FORCED_ERR
static java.lang.String
PROP_OUTPUT_FORCED_OUT
static java.lang.String
PROP_OUTPUT_OUT
static java.lang.String
PROP_OUTPUT_OUT_ERR
static java.lang.String
PROP_PROVIDER
static java.lang.String
PROP_PROVIDER_DUMB
static java.lang.String
PROP_PROVIDER_EXEC
static java.lang.String
PROP_PROVIDER_FFM
static java.lang.String
PROP_PROVIDER_JANSI
static java.lang.String
PROP_PROVIDER_JNA
static java.lang.String
PROP_PROVIDER_JNI
static java.lang.String
PROP_PROVIDERS
static java.lang.String
PROP_PROVIDERS_DEFAULT
static java.lang.String
PROP_REDIRECT_PIPE_CREATION_MODE
static java.lang.String
PROP_REDIRECT_PIPE_CREATION_MODE_DEFAULT
static java.lang.String
PROP_REDIRECT_PIPE_CREATION_MODE_NATIVE
static java.lang.String
PROP_REDIRECT_PIPE_CREATION_MODE_REFLECTION
static java.lang.String
PROP_STDERR_ENCODING
static java.lang.String
PROP_STDIN_ENCODING
static java.lang.String
PROP_STDOUT_ENCODING
static java.lang.String
PROP_TYPE
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TerminalBuilder
attributes(Attributes attributes)
Attributes to use when creating a non system terminal, i.e.Terminal
build()
Builds the terminal.static TerminalBuilder
builder()
Creates a new terminal builder instance for configuring and creating terminals.TerminalBuilder
codepage(int codepage)
Deprecated.JLine now writes Unicode output independently from the selected code page.TerminalBuilder
color(boolean color)
java.nio.charset.Charset
computeEncoding()
java.nio.charset.Charset
computeStderrEncoding()
java.nio.charset.Charset
computeStdinEncoding()
java.nio.charset.Charset
computeStdoutEncoding()
TerminalBuilder.SystemOutput
computeSystemOutput()
java.lang.String
computeType()
TerminalBuilder
dumb(boolean dumb)
Enables or disables thePROP_PROVIDER_DUMB
/dumb
terminal provider.TerminalBuilder
encoding(java.lang.String encoding)
Set the encoding to use for reading/writing from the console.TerminalBuilder
encoding(java.nio.charset.Charset encoding)
Set theCharset
to use for reading/writing from the console.TerminalBuilder
exec(boolean exec)
Enables or disables thePROP_PROVIDER_EXEC
/exec
terminal provider.TerminalBuilder
ffm(boolean ffm)
Enables or disables thePROP_PROVIDER_FFM
/ffm
terminal provider.java.util.List<TerminalProvider>
getProviders(java.lang.String provider, java.lang.IllegalStateException exception)
Get the list of available terminal providers.TerminalBuilder
jansi(boolean jansi)
Enables or disables thePROP_PROVIDER_JANSI
/jansi
terminal provider.TerminalBuilder
jna(boolean jna)
Enables or disables thePROP_PROVIDER_JNA
/jna
terminal provider.TerminalBuilder
jni(boolean jni)
Enables or disables thePROP_PROVIDER_JNI
/jni
terminal provider.TerminalBuilder
name(java.lang.String name)
TerminalBuilder
nativeSignals(boolean nativeSignals)
TerminalBuilder
paused(boolean paused)
Initial paused state of the terminal (defaults to false).TerminalBuilder
provider(java.lang.String provider)
Forces the usage of the give terminal provider.TerminalBuilder
providers(java.lang.String providers)
Sets the list of providers to try when creating the terminal.static void
setTerminalOverride(Terminal terminal)
Deprecated.TerminalBuilder
signalHandler(Terminal.SignalHandler signalHandler)
Determines the default value for signal handlers.TerminalBuilder
size(Size size)
Initial size to use when creating a non system terminal, i.e.TerminalBuilder
stderrEncoding(java.lang.String encoding)
Set the encoding to use for writing to standard error.TerminalBuilder
stderrEncoding(java.nio.charset.Charset encoding)
Set theCharset
to use for writing to standard error.TerminalBuilder
stdinEncoding(java.lang.String encoding)
Set the encoding to use for reading from standard input.TerminalBuilder
stdinEncoding(java.nio.charset.Charset encoding)
Set theCharset
to use for reading from standard input.TerminalBuilder
stdoutEncoding(java.lang.String encoding)
Set the encoding to use for writing to standard output.TerminalBuilder
stdoutEncoding(java.nio.charset.Charset encoding)
Set theCharset
to use for writing to standard output.TerminalBuilder
streams(java.io.InputStream in, java.io.OutputStream out)
TerminalBuilder
system(boolean system)
TerminalBuilder
systemOutput(TerminalBuilder.SystemOutput systemOutput)
Indicates which standard stream should be used when displaying to the terminal.static Terminal
terminal()
Returns the default system terminal with automatic configuration.TerminalBuilder
type(java.lang.String type)
-
-
-
Field Detail
-
PROP_ENCODING
public static final java.lang.String PROP_ENCODING
- See Also:
- Constant Field Values
-
PROP_STDIN_ENCODING
public static final java.lang.String PROP_STDIN_ENCODING
- See Also:
- Constant Field Values
-
PROP_STDOUT_ENCODING
public static final java.lang.String PROP_STDOUT_ENCODING
- See Also:
- Constant Field Values
-
PROP_STDERR_ENCODING
public static final java.lang.String PROP_STDERR_ENCODING
- See Also:
- Constant Field Values
-
PROP_CODEPAGE
public static final java.lang.String PROP_CODEPAGE
- See Also:
- Constant Field Values
-
PROP_TYPE
public static final java.lang.String PROP_TYPE
- See Also:
- Constant Field Values
-
PROP_PROVIDER
public static final java.lang.String PROP_PROVIDER
- See Also:
- Constant Field Values
-
PROP_PROVIDERS
public static final java.lang.String PROP_PROVIDERS
- See Also:
- Constant Field Values
-
PROP_PROVIDER_FFM
public static final java.lang.String PROP_PROVIDER_FFM
- See Also:
- Constant Field Values
-
PROP_PROVIDER_JNI
public static final java.lang.String PROP_PROVIDER_JNI
- See Also:
- Constant Field Values
-
PROP_PROVIDER_JANSI
public static final java.lang.String PROP_PROVIDER_JANSI
- See Also:
- Constant Field Values
-
PROP_PROVIDER_JNA
public static final java.lang.String PROP_PROVIDER_JNA
- See Also:
- Constant Field Values
-
PROP_PROVIDER_EXEC
public static final java.lang.String PROP_PROVIDER_EXEC
- See Also:
- Constant Field Values
-
PROP_PROVIDER_DUMB
public static final java.lang.String PROP_PROVIDER_DUMB
- See Also:
- Constant Field Values
-
PROP_PROVIDERS_DEFAULT
public static final java.lang.String PROP_PROVIDERS_DEFAULT
-
PROP_FFM
public static final java.lang.String PROP_FFM
- See Also:
- Constant Field Values
-
PROP_JNI
public static final java.lang.String PROP_JNI
- See Also:
- Constant Field Values
-
PROP_JANSI
public static final java.lang.String PROP_JANSI
- See Also:
- Constant Field Values
-
PROP_JNA
public static final java.lang.String PROP_JNA
- See Also:
- Constant Field Values
-
PROP_EXEC
public static final java.lang.String PROP_EXEC
- See Also:
- Constant Field Values
-
PROP_DUMB
public static final java.lang.String PROP_DUMB
- See Also:
- Constant Field Values
-
PROP_DUMB_COLOR
public static final java.lang.String PROP_DUMB_COLOR
- See Also:
- Constant Field Values
-
PROP_OUTPUT
public static final java.lang.String PROP_OUTPUT
- See Also:
- Constant Field Values
-
PROP_OUTPUT_OUT
public static final java.lang.String PROP_OUTPUT_OUT
- See Also:
- Constant Field Values
-
PROP_OUTPUT_ERR
public static final java.lang.String PROP_OUTPUT_ERR
- See Also:
- Constant Field Values
-
PROP_OUTPUT_OUT_ERR
public static final java.lang.String PROP_OUTPUT_OUT_ERR
- See Also:
- Constant Field Values
-
PROP_OUTPUT_ERR_OUT
public static final java.lang.String PROP_OUTPUT_ERR_OUT
- See Also:
- Constant Field Values
-
PROP_OUTPUT_FORCED_OUT
public static final java.lang.String PROP_OUTPUT_FORCED_OUT
- See Also:
- Constant Field Values
-
PROP_OUTPUT_FORCED_ERR
public static final java.lang.String PROP_OUTPUT_FORCED_ERR
- See Also:
- Constant Field Values
-
PROP_NON_BLOCKING_READS
public static final java.lang.String PROP_NON_BLOCKING_READS
- See Also:
- Constant Field Values
-
PROP_COLOR_DISTANCE
public static final java.lang.String PROP_COLOR_DISTANCE
- See Also:
- Constant Field Values
-
PROP_DISABLE_ALTERNATE_CHARSET
public static final java.lang.String PROP_DISABLE_ALTERNATE_CHARSET
- See Also:
- Constant Field Values
-
PROP_FILE_DESCRIPTOR_CREATION_MODE
public static final java.lang.String PROP_FILE_DESCRIPTOR_CREATION_MODE
- See Also:
- Constant Field Values
-
PROP_FILE_DESCRIPTOR_CREATION_MODE_NATIVE
public static final java.lang.String PROP_FILE_DESCRIPTOR_CREATION_MODE_NATIVE
- See Also:
- Constant Field Values
-
PROP_FILE_DESCRIPTOR_CREATION_MODE_REFLECTION
public static final java.lang.String PROP_FILE_DESCRIPTOR_CREATION_MODE_REFLECTION
- See Also:
- Constant Field Values
-
PROP_FILE_DESCRIPTOR_CREATION_MODE_DEFAULT
public static final java.lang.String PROP_FILE_DESCRIPTOR_CREATION_MODE_DEFAULT
-
PROP_REDIRECT_PIPE_CREATION_MODE
public static final java.lang.String PROP_REDIRECT_PIPE_CREATION_MODE
- See Also:
- Constant Field Values
-
PROP_REDIRECT_PIPE_CREATION_MODE_NATIVE
public static final java.lang.String PROP_REDIRECT_PIPE_CREATION_MODE_NATIVE
- See Also:
- Constant Field Values
-
PROP_REDIRECT_PIPE_CREATION_MODE_REFLECTION
public static final java.lang.String PROP_REDIRECT_PIPE_CREATION_MODE_REFLECTION
- See Also:
- Constant Field Values
-
PROP_REDIRECT_PIPE_CREATION_MODE_DEFAULT
public static final java.lang.String PROP_REDIRECT_PIPE_CREATION_MODE_DEFAULT
-
DEPRECATED_PROVIDERS
public static final java.util.Set<java.lang.String> DEPRECATED_PROVIDERS
-
PROP_DISABLE_DEPRECATED_PROVIDER_WARNING
public static final java.lang.String PROP_DISABLE_DEPRECATED_PROVIDER_WARNING
- See Also:
- Constant Field Values
-
-
Method Detail
-
terminal
public static Terminal terminal() throws java.io.IOException
Returns the default system terminal with automatic configuration.This method creates a terminal connected to the system's standard input and output streams, automatically detecting the appropriate terminal type and capabilities for the current environment. It's the simplest way to get a working terminal instance for most applications.
The terminal is created with default settings, which include:
- System streams for input and output
- Auto-detected terminal type
- System default encoding
- Native signal handling
This call is equivalent to:
builder().build()
Important: Terminals should be closed properly using the
Closeable.close()
method when they are no longer needed in order to restore the original terminal state.Example usage:
try (Terminal terminal = TerminalBuilder.terminal()) { terminal.writer().println("Hello, terminal!"); terminal.flush(); // Use terminal... }
- Returns:
- the default system terminal, never
null
- Throws:
java.io.IOException
- if an error occurs during terminal creation- See Also:
builder()
-
builder
public static TerminalBuilder builder()
Creates a new terminal builder instance for configuring and creating terminals.This method returns a builder that can be used to configure various aspects of the terminal before creating it. The builder provides a fluent API for setting terminal properties such as name, type, encoding, input/output streams, and more.
Example usage:
Terminal terminal = TerminalBuilder.builder() .name("MyTerminal") .system(true) .encoding(StandardCharsets.UTF_8) .build();
- Returns:
- a new terminal builder instance, never
null
- See Also:
terminal()
-
name
public TerminalBuilder name(java.lang.String name)
-
streams
public TerminalBuilder streams(java.io.InputStream in, java.io.OutputStream out)
-
system
public TerminalBuilder system(boolean system)
-
systemOutput
public TerminalBuilder systemOutput(TerminalBuilder.SystemOutput systemOutput)
Indicates which standard stream should be used when displaying to the terminal. The default is to use the system output stream. Building a system terminal will fail if one of the stream specified is not linked to the controlling terminal.- Parameters:
systemOutput
- The mode to choose the output stream.- Returns:
- The builder.
-
provider
public TerminalBuilder provider(java.lang.String provider)
Forces the usage of the give terminal provider.- Parameters:
provider
- TheTerminalProvider
's name to use when creating the Terminal.- Returns:
- The builder.
-
providers
public TerminalBuilder providers(java.lang.String providers)
Sets the list of providers to try when creating the terminal. If not specified, the system propertyPROP_PROVIDERS
will be used if set. Else, the valuePROP_PROVIDERS_DEFAULT
will be used.- Parameters:
providers
- The list ofTerminalProvider
's names to check when creating the Terminal.- Returns:
- The builder.
-
jna
public TerminalBuilder jna(boolean jna)
Enables or disables thePROP_PROVIDER_JNA
/jna
terminal provider. If not specified, the system propertyPROP_JNA
will be used if set. If not specified, the provider will be checked.
-
jansi
public TerminalBuilder jansi(boolean jansi)
Enables or disables thePROP_PROVIDER_JANSI
/jansi
terminal provider. If not specified, the system propertyPROP_JANSI
will be used if set. If not specified, the provider will be checked.
-
jni
public TerminalBuilder jni(boolean jni)
Enables or disables thePROP_PROVIDER_JNI
/jni
terminal provider.The JNI provider uses the JLine native library loaded by
JLineNativeLoader
to access low-level terminal functionality. This provider generally offers the best performance and most complete terminal support.If not specified, the system property
PROP_JNI
will be used if set. If not specified, the provider will be checked for availability.The native library loading can be configured using system properties as documented in
JLineNativeLoader
.- Parameters:
jni
- true to enable the JNI provider, false to disable it- Returns:
- this builder
- See Also:
JLineNativeLoader
-
exec
public TerminalBuilder exec(boolean exec)
Enables or disables thePROP_PROVIDER_EXEC
/exec
terminal provider. If not specified, the system propertyPROP_EXEC
will be used if set. If not specified, the provider will be checked.
-
ffm
public TerminalBuilder ffm(boolean ffm)
Enables or disables thePROP_PROVIDER_FFM
/ffm
terminal provider. If not specified, the system propertyPROP_FFM
will be used if set. If not specified, the provider will be checked.
-
dumb
public TerminalBuilder dumb(boolean dumb)
Enables or disables thePROP_PROVIDER_DUMB
/dumb
terminal provider. If not specified, the system propertyPROP_DUMB
will be used if set. If not specified, the provider will be checked.
-
type
public TerminalBuilder type(java.lang.String type)
-
color
public TerminalBuilder color(boolean color)
-
encoding
public TerminalBuilder encoding(java.lang.String encoding) throws java.nio.charset.UnsupportedCharsetException
Set the encoding to use for reading/writing from the console. Ifnull
(the default value), JLine will automatically select aCharset
, usually the default system encoding. However, on some platforms (e.g. Windows) it may use a different one depending on theTerminal
implementation.Use
Terminal.encoding()
to get theCharset
that should be used for aTerminal
.This method sets a single encoding for all streams (stdin, stdout, stderr). To set separate encodings for each stream, use
stdinEncoding(Charset)
,stdoutEncoding(Charset)
, andstderrEncoding(Charset)
.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- Throws:
java.nio.charset.UnsupportedCharsetException
- If the given encoding is not supported- See Also:
Terminal.encoding()
-
encoding
public TerminalBuilder encoding(java.nio.charset.Charset encoding)
Set theCharset
to use for reading/writing from the console. Ifnull
(the default value), JLine will automatically select aCharset
, usually the default system encoding. However, on some platforms (e.g. Windows) it may use a different one depending on theTerminal
implementation.Use
Terminal.encoding()
to get theCharset
that should be used to read/write from aTerminal
.This method sets a single encoding for all streams (stdin, stdout, stderr). To set separate encodings for each stream, use
stdinEncoding(Charset)
,stdoutEncoding(Charset)
, andstderrEncoding(Charset)
.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- See Also:
Terminal.encoding()
-
stdinEncoding
public TerminalBuilder stdinEncoding(java.lang.String encoding) throws java.nio.charset.UnsupportedCharsetException
Set the encoding to use for reading from standard input. Ifnull
(the default value), JLine will use the value from the "stdin.encoding" system property if set, or fall back to the general encoding.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- Throws:
java.nio.charset.UnsupportedCharsetException
- If the given encoding is not supported- See Also:
Terminal.stdinEncoding()
-
stdinEncoding
public TerminalBuilder stdinEncoding(java.nio.charset.Charset encoding)
Set theCharset
to use for reading from standard input. Ifnull
(the default value), JLine will use the value from the "stdin.encoding" system property if set, or fall back to the general encoding.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- See Also:
Terminal.stdinEncoding()
-
stdoutEncoding
public TerminalBuilder stdoutEncoding(java.lang.String encoding) throws java.nio.charset.UnsupportedCharsetException
Set the encoding to use for writing to standard output. Ifnull
(the default value), JLine will use the value from the "stdout.encoding" system property if set, or fall back to the general encoding.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- Throws:
java.nio.charset.UnsupportedCharsetException
- If the given encoding is not supported- See Also:
Terminal.stdoutEncoding()
-
stdoutEncoding
public TerminalBuilder stdoutEncoding(java.nio.charset.Charset encoding)
Set theCharset
to use for writing to standard output. Ifnull
(the default value), JLine will use the value from the "stdout.encoding" system property if set, or fall back to the general encoding.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- See Also:
Terminal.stdoutEncoding()
-
stderrEncoding
public TerminalBuilder stderrEncoding(java.lang.String encoding) throws java.nio.charset.UnsupportedCharsetException
Set the encoding to use for writing to standard error. Ifnull
(the default value), JLine will use the value from the "stderr.encoding" system property if set, or fall back to the general encoding.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- Throws:
java.nio.charset.UnsupportedCharsetException
- If the given encoding is not supported- See Also:
Terminal.stderrEncoding()
-
stderrEncoding
public TerminalBuilder stderrEncoding(java.nio.charset.Charset encoding)
Set theCharset
to use for writing to standard error. Ifnull
(the default value), JLine will use the value from the "stderr.encoding" system property if set, or fall back to the general encoding.- Parameters:
encoding
- The encoding to use or null to automatically select one- Returns:
- The builder
- See Also:
Terminal.stderrEncoding()
-
codepage
@Deprecated public TerminalBuilder codepage(int codepage)
Deprecated.JLine now writes Unicode output independently from the selected code page. Using this option will only make it emulate the selected code page forTerminal.input()
andTerminal.output()
.- Parameters:
codepage
- the codepage- Returns:
- The builder
-
attributes
public TerminalBuilder attributes(Attributes attributes)
Attributes to use when creating a non system terminal, i.e. when the builder has been given the input and output streams using thestreams(InputStream, OutputStream)
method or whensystem(boolean)
has been explicitly called withfalse
.- Parameters:
attributes
- the attributes to use- Returns:
- The builder
- See Also:
size(Size)
,system(boolean)
-
size
public TerminalBuilder size(Size size)
Initial size to use when creating a non system terminal, i.e. when the builder has been given the input and output streams using thestreams(InputStream, OutputStream)
method or whensystem(boolean)
has been explicitly called withfalse
.- Parameters:
size
- the initial size- Returns:
- The builder
- See Also:
attributes(Attributes)
,system(boolean)
-
nativeSignals
public TerminalBuilder nativeSignals(boolean nativeSignals)
-
signalHandler
public TerminalBuilder signalHandler(Terminal.SignalHandler signalHandler)
Determines the default value for signal handlers. All signals will be mapped to the given handler.- Parameters:
signalHandler
- the default signal handler- Returns:
- The builder
-
paused
public TerminalBuilder paused(boolean paused)
Initial paused state of the terminal (defaults to false). By default, the terminal is started, but in some cases, one might want to make sure the input stream is not consumed before needed, in which case the terminal needs to be created in a paused state.- Parameters:
paused
- the initial paused state- Returns:
- The builder
- See Also:
Terminal.pause()
-
build
public Terminal build() throws java.io.IOException
Builds the terminal.- Returns:
- the newly created terminal, never
null
- Throws:
java.io.IOException
- if an error occurs
-
computeSystemOutput
public TerminalBuilder.SystemOutput computeSystemOutput()
-
computeType
public java.lang.String computeType()
-
computeEncoding
public java.nio.charset.Charset computeEncoding()
-
computeStdinEncoding
public java.nio.charset.Charset computeStdinEncoding()
-
computeStdoutEncoding
public java.nio.charset.Charset computeStdoutEncoding()
-
computeStderrEncoding
public java.nio.charset.Charset computeStderrEncoding()
-
getProviders
public java.util.List<TerminalProvider> getProviders(java.lang.String provider, java.lang.IllegalStateException exception)
Get the list of available terminal providers. This list is sorted according to thePROP_PROVIDERS
system property.- Parameters:
provider
- if notnull
, only this provider will be checkedexception
- if a provider throws an exception, it will be added to this exception as a suppressed exception- Returns:
- a list of terminal providers
-
setTerminalOverride
@Deprecated public static void setTerminalOverride(Terminal terminal)
Deprecated.Allows an application to override the result ofbuild()
. The intended use case is to allow a container or server application to control an embedded application that uses a LineReader that uses Terminal constructed with TerminalBuilder.build but provides no public api for setting theLineReader
of theTerminal
. For example, the sbt build tool uses aLineReader
to implement an interactive shell. One of its supported commands isconsole
which invokes the scala REPL. The scala REPL also uses aLineReader
and it is necessary to override theTerminal
used by the the REPL to share the sameTerminal
instance used by sbt.When this method is called with a non-null
Terminal
, all subsequent calls tobuild()
will return the providedTerminal
regardless of how theTerminalBuilder
was constructed. The default behavior ofTerminalBuilder
can be restored by calling setTerminalOverride with a nullTerminal
Usage of setTerminalOverride should be restricted to cases where it isn't possible to update the api of the nested application to accept a
instance
.- Parameters:
terminal
- theTerminal
to globally override
-
-