OpenJDK 27 · jdk.internal.org.jline.terminal.TerminalBuilder

Modifier and Type	Class and Description
public static enum	TerminalBuilder.SystemOutput

Modifier and Type	Field and Description
private Attributes	attributes
private int	codepage
private Boolean	color
public static final Set<String>	DEPRECATED_PROVIDERS
private Boolean	dumb
private Charset	encoding
private Boolean	exec
private Boolean	ffm
private InputStream	in
private Function<InputStream, InputStream>	inputStreamWrapper
private Boolean	jansi
private Boolean	jna
private Boolean	jni
private String	name
private boolean	nativeSignals
private OutputStream	out
private boolean	paused
public static final String	PROP_CODEPAGE
public static final String	PROP_COLOR_DISTANCE
public static final String	PROP_DISABLE_ALTERNATE_CHARSET
public static final String	PROP_DISABLE_DEPRECATED_PROVIDER_WARNING
public static final String	PROP_DUMB
public static final String	PROP_DUMB_COLOR
public static final String	PROP_ENCODING
public static final String	PROP_EXEC
public static final String	PROP_FFM
public static final String	PROP_FILE_DESCRIPTOR_CREATION_MODE
public static final String	PROP_FILE_DESCRIPTOR_CREATION_MODE_DEFAULT
public static final String	PROP_FILE_DESCRIPTOR_CREATION_MODE_NATIVE
public static final String	PROP_FILE_DESCRIPTOR_CREATION_MODE_REFLECTION
public static final String	PROP_JANSI
public static final String	PROP_JNA
public static final String	PROP_JNI
public static final String	PROP_NON_BLOCKING_READS
public static final String	PROP_OUTPUT
public static final String	PROP_OUTPUT_ERR
public static final String	PROP_OUTPUT_ERR_OUT
public static final String	PROP_OUTPUT_FORCED_ERR
public static final String	PROP_OUTPUT_FORCED_OUT
public static final String	PROP_OUTPUT_OUT
public static final String	PROP_OUTPUT_OUT_ERR
public static final String	PROP_PROVIDER
public static final String	PROP_PROVIDER_DUMB
public static final String	PROP_PROVIDER_EXEC
public static final String	PROP_PROVIDER_FFM
public static final String	PROP_PROVIDER_JANSI
public static final String	PROP_PROVIDER_JNA
public static final String	PROP_PROVIDER_JNI
public static final String	PROP_PROVIDERS
public static final String	PROP_PROVIDERS_DEFAULT
public static final String	PROP_REDIRECT_PIPE_CREATION_MODE
public static final String	PROP_REDIRECT_PIPE_CREATION_MODE_DEFAULT
public static final String	PROP_REDIRECT_PIPE_CREATION_MODE_NATIVE
public static final String	PROP_REDIRECT_PIPE_CREATION_MODE_REFLECTION
public static final String	PROP_TYPE
private String	provider
private String	providers
private Terminal.SignalHandler	signalHandler
private Size	size
private Boolean	system
private static final AtomicReference<Terminal>	SYSTEM_TERMINAL
private TerminalBuilder.SystemOutput	systemOutput
private static final AtomicReference<Terminal>	TERMINAL_OVERRIDE
private String	type
private static final int	UTF8_CODE_PAGE

Access	Constructor and Description
private	TerminalBuilder()

Method Summary

Modifier and Type	Method and Description
public TerminalBuilder	Returns: The builder attributes(Attributes the attributes to use attributes) Attributes to use when creating a non system terminal, i.e. when the builder has been given the input and output streams using the `streams(InputStream, OutputStream)` method or when `system(boolean)` has been explicitly called with `false`.
public Terminal	Returns: the newly created terminal, never `null` build() Builds the terminal.
public static TerminalBuilder	Returns: a builder builder() Creates a new terminal builder instance.
private void	checkProvider(String provider, IllegalStateException exception, List<TerminalProvider> providers, Boolean load, String property, String name)
public TerminalBuilder	codepage(int the codepage codepage) Deprecated JLine now writes Unicode output independently from the selected code page. Returns: The builder
public TerminalBuilder	color(boolean color)
public Charset	computeEncoding()
public TerminalBuilder.SystemOutput	computeSystemOutput()
public String	computeType()
private Terminal	doBuild()
public TerminalBuilder	dumb(boolean dumb) Enables or disables the `PROP_PROVIDER_DUMB`/`dumb` terminal provider.
public TerminalBuilder	Returns: The builder encoding(String The encoding to use or null to automatically select one encoding) Set the encoding to use for reading/writing from the console.
public TerminalBuilder	Returns: The builder encoding(Charset The encoding to use or null to automatically select one encoding) Set the `Charset` to use for reading/writing from the console.
public TerminalBuilder	exec(boolean exec) Enables or disables the `PROP_PROVIDER_EXEC`/`exec` terminal provider.
public TerminalBuilder	ffm(boolean ffm) Enables or disables the `PROP_PROVIDER_FFM`/`ffm` terminal provider.
private static Boolean	getBoolean(String name, Boolean def)
private static Charset	getCodepageCharset(int codepage)
private String	getDumbTerminalType(Boolean dumb, SystemStream systemStream)
private static String	getParentProcessCommand()
public List<TerminalProvider>	Returns: a list of terminal providers getProviders(String if not `null`, only this provider will be checked provider, IllegalStateException if a provider throws an exception, it will be added to this exception as a suppressed exception exception) Get the list of available terminal providers.
public TerminalBuilder	inputStreamWrapper(Function<InputStream, InputStream> wrapper)
public TerminalBuilder	jansi(boolean jansi) Enables or disables the `PROP_PROVIDER_JANSI`/`jansi` terminal provider.
public TerminalBuilder	jna(boolean jna) Enables or disables the `PROP_PROVIDER_JNA`/`jna` terminal provider.
public TerminalBuilder	jni(boolean jni) Enables or disables the `PROP_PROVIDER_JNI`/`jni` terminal provider.
private static <S> S	load(Class<S> clazz)
public TerminalBuilder	name(String name)
public TerminalBuilder	nativeSignals(boolean nativeSignals)
public TerminalBuilder	Returns: The builder paused(boolean the initial paused state paused) Initial paused state of the terminal (defaults to false).
public TerminalBuilder	Returns: The builder. provider(String The `TerminalProvider`'s name to use when creating the Terminal. provider) Forces the usage of the give terminal provider.
public TerminalBuilder	Returns: The builder. providers(String The list of `TerminalProvider`'s names to check when creating the Terminal. providers) Sets the list of providers to try when creating the terminal.
private SystemStream	select(Map<SystemStream, Boolean> system, TerminalBuilder.SystemOutput systemOutput)
private static SystemStream	select(Map<SystemStream, Boolean> system, SystemStream... streams)
public static void	setTerminalOverride(final Terminal the `Terminal` to globally override terminal) Deprecated Allows an application to override the result of `build()`.
public TerminalBuilder	Returns: The builder signalHandler(Terminal.SignalHandler the default signal handler signalHandler) Determines the default value for signal handlers.
public TerminalBuilder	Returns: The builder size(Size the initial 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 the `streams(InputStream, OutputStream)` method or when `system(boolean)` has been explicitly called with `false`.
public TerminalBuilder	streams(InputStream in, OutputStream out)
public TerminalBuilder	system(boolean system)
public TerminalBuilder	Returns: The builder. systemOutput(TerminalBuilder.SystemOutput The mode to choose the output stream. systemOutput) Indicates which standard stream should be used when displaying to the terminal.
public static Terminal	Returns: the default system terminal terminal() Returns the default system terminal.
public TerminalBuilder	type(String type)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributes	back to summary
private Attributes attributes

codepage	back to summary
private int codepage

color	back to summary
private Boolean color

DEPRECATED_PROVIDERS	back to summary
public static final Set<String> DEPRECATED_PROVIDERS

dumb	back to summary
private Boolean dumb

encoding	back to summary
private Charset encoding

exec	back to summary
private Boolean exec

ffm	back to summary
private Boolean ffm

in	back to summary
private InputStream in

inputStreamWrapper	back to summary
private Function<InputStream, InputStream> inputStreamWrapper

jansi	back to summary
private Boolean jansi

jna	back to summary
private Boolean jna

jni	back to summary
private Boolean jni

name	back to summary
private String name

nativeSignals	back to summary
private boolean nativeSignals

out	back to summary
private OutputStream out

paused	back to summary
private boolean paused

PROP_CODEPAGE	back to summary
public static final String PROP_CODEPAGE

PROP_COLOR_DISTANCE	back to summary
public static final String PROP_COLOR_DISTANCE

PROP_DISABLE_ALTERNATE_CHARSET	back to summary
public static final String PROP_DISABLE_ALTERNATE_CHARSET

PROP_DISABLE_DEPRECATED_PROVIDER_WARNING	back to summary
public static final String PROP_DISABLE_DEPRECATED_PROVIDER_WARNING

PROP_DUMB	back to summary
public static final String PROP_DUMB

PROP_DUMB_COLOR	back to summary
public static final String PROP_DUMB_COLOR

PROP_ENCODING	back to summary
public static final String PROP_ENCODING

PROP_EXEC	back to summary
public static final String PROP_EXEC

PROP_FFM	back to summary
public static final String PROP_FFM

PROP_FILE_DESCRIPTOR_CREATION_MODE	back to summary
public static final String PROP_FILE_DESCRIPTOR_CREATION_MODE

PROP_FILE_DESCRIPTOR_CREATION_MODE_DEFAULT	back to summary
public static final String PROP_FILE_DESCRIPTOR_CREATION_MODE_DEFAULT

PROP_FILE_DESCRIPTOR_CREATION_MODE_NATIVE	back to summary
public static final String PROP_FILE_DESCRIPTOR_CREATION_MODE_NATIVE

PROP_FILE_DESCRIPTOR_CREATION_MODE_REFLECTION	back to summary
public static final String PROP_FILE_DESCRIPTOR_CREATION_MODE_REFLECTION

PROP_JANSI	back to summary
public static final String PROP_JANSI

PROP_JNA	back to summary
public static final String PROP_JNA

PROP_JNI	back to summary
public static final String PROP_JNI

PROP_NON_BLOCKING_READS	back to summary
public static final String PROP_NON_BLOCKING_READS

PROP_OUTPUT	back to summary
public static final String PROP_OUTPUT

PROP_OUTPUT_ERR	back to summary
public static final String PROP_OUTPUT_ERR

PROP_OUTPUT_ERR_OUT	back to summary
public static final String PROP_OUTPUT_ERR_OUT

PROP_OUTPUT_FORCED_ERR	back to summary
public static final String PROP_OUTPUT_FORCED_ERR

PROP_OUTPUT_FORCED_OUT	back to summary
public static final String PROP_OUTPUT_FORCED_OUT

PROP_OUTPUT_OUT	back to summary
public static final String PROP_OUTPUT_OUT

PROP_OUTPUT_OUT_ERR	back to summary
public static final String PROP_OUTPUT_OUT_ERR

PROP_PROVIDER	back to summary
public static final String PROP_PROVIDER

PROP_PROVIDER_DUMB	back to summary
public static final String PROP_PROVIDER_DUMB

PROP_PROVIDER_EXEC	back to summary
public static final String PROP_PROVIDER_EXEC

PROP_PROVIDER_FFM	back to summary
public static final String PROP_PROVIDER_FFM

PROP_PROVIDER_JANSI	back to summary
public static final String PROP_PROVIDER_JANSI

PROP_PROVIDER_JNA	back to summary
public static final String PROP_PROVIDER_JNA

PROP_PROVIDER_JNI	back to summary
public static final String PROP_PROVIDER_JNI

PROP_PROVIDERS	back to summary
public static final String PROP_PROVIDERS

PROP_PROVIDERS_DEFAULT	back to summary
public static final String PROP_PROVIDERS_DEFAULT

PROP_REDIRECT_PIPE_CREATION_MODE	back to summary
public static final String PROP_REDIRECT_PIPE_CREATION_MODE

PROP_REDIRECT_PIPE_CREATION_MODE_DEFAULT	back to summary
public static final String PROP_REDIRECT_PIPE_CREATION_MODE_DEFAULT

PROP_REDIRECT_PIPE_CREATION_MODE_NATIVE	back to summary
public static final String PROP_REDIRECT_PIPE_CREATION_MODE_NATIVE

PROP_REDIRECT_PIPE_CREATION_MODE_REFLECTION	back to summary
public static final String PROP_REDIRECT_PIPE_CREATION_MODE_REFLECTION

PROP_TYPE	back to summary
public static final String PROP_TYPE

provider	back to summary
private String provider

providers	back to summary
private String providers

signalHandler	back to summary
private Terminal.SignalHandler signalHandler

size	back to summary
private Size size

system	back to summary
private Boolean system

SYSTEM_TERMINAL	back to summary
private static final AtomicReference<Terminal> SYSTEM_TERMINAL

systemOutput	back to summary
private TerminalBuilder.SystemOutput systemOutput

TERMINAL_OVERRIDE	back to summary
private static final AtomicReference<Terminal> TERMINAL_OVERRIDE

type	back to summary
private String type

UTF8_CODE_PAGE	back to summary
private static final int UTF8_CODE_PAGE

Constructor Detail

TerminalBuilder	back to summary
private TerminalBuilder()

Method Detail

attributes back to summary

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 the streams(InputStream, OutputStream) method or when system(boolean) has been explicitly called with false.

Parameters

attributes:Attributes: the attributes to use

Returns:TerminalBuilder

The builder

See Also

size(Size), system(boolean)

build back to summary

public Terminal build() throws IOException

Builds the terminal.

Returns:Terminal

the newly created terminal, never null

Exceptions

IOException:: if an error occurs

builder

back to summary

public static TerminalBuilder builder()

Creates a new terminal builder instance.

Returns:TerminalBuilder: a builder

checkProvider	back to summary
private void checkProvider(String provider, IllegalStateException exception, List<TerminalProvider> providers, Boolean load, String property, String name)

codepage	back to summary
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 for `Terminal#input()` and `Terminal#output()`. Parameters codepage:int the codepage Returns:TerminalBuilder The builder Annotations @Deprecated

color	back to summary
public TerminalBuilder color(boolean color)

computeEncoding	back to summary
public Charset computeEncoding()

computeSystemOutput	back to summary
public TerminalBuilder.SystemOutput computeSystemOutput()

computeType	back to summary
public String computeType()

doBuild	back to summary
private Terminal doBuild() throws IOException

dumb	back to summary
public TerminalBuilder dumb(boolean dumb) Enables or disables the `PROP_PROVIDER_DUMB`/`dumb` terminal provider. If not specified, the system property `PROP_DUMB` will be used if set. If not specified, the provider will be checked.

encoding back to summary

public TerminalBuilder encoding(String encoding) throws UnsupportedCharsetException

Set the encoding to use for reading/writing from the console. If null (the default value), JLine will automatically select a Charset, usually the default system encoding. However, on some platforms (e.g. Windows) it may use a different one depending on the Terminal implementation.

Use Terminal#encoding() to get the Charset that should be used for a Terminal.

Parameters

encoding:String: The encoding to use or null to automatically select one

Returns:TerminalBuilder

The builder

Exceptions

UnsupportedCharsetException:: If the given encoding is not supported

See Also

Terminal#encoding()

encoding back to summary

public TerminalBuilder encoding(Charset encoding)

Set the Charset to use for reading/writing from the console. If null (the default value), JLine will automatically select a Charset, usually the default system encoding. However, on some platforms (e.g. Windows) it may use a different one depending on the Terminal implementation.

Use Terminal#encoding() to get the Charset that should be used to read/write from a Terminal.

Parameters

encoding:Charset: The encoding to use or null to automatically select one

Returns:TerminalBuilder

The builder

See Also

Terminal#encoding()

exec	back to summary
public TerminalBuilder exec(boolean exec) Enables or disables the `PROP_PROVIDER_EXEC`/`exec` terminal provider. If not specified, the system property `PROP_EXEC` will be used if set. If not specified, the provider will be checked.

ffm	back to summary
public TerminalBuilder ffm(boolean ffm) Enables or disables the `PROP_PROVIDER_FFM`/`ffm` terminal provider. If not specified, the system property `PROP_FFM` will be used if set. If not specified, the provider will be checked.

getBoolean	back to summary
private static Boolean getBoolean(String name, Boolean def)

getCodepageCharset	back to summary
private static Charset getCodepageCharset(int codepage)

getDumbTerminalType	back to summary
private String getDumbTerminalType(Boolean dumb, SystemStream systemStream)

getParentProcessCommand	back to summary
private static String getParentProcessCommand()

getProviders back to summary

public List<TerminalProvider> getProviders(String provider, IllegalStateException exception)

Get the list of available terminal providers. This list is sorted according to the PROP_PROVIDERS system property.

Parameters

provider:String: if not null, only this provider will be checked
exception:IllegalStateException: if a provider throws an exception, it will be added to this exception as a suppressed exception

Returns:List<TerminalProvider>

a list of terminal providers

inputStreamWrapper	back to summary
public TerminalBuilder inputStreamWrapper(Function<InputStream, InputStream> wrapper)

jansi	back to summary
public TerminalBuilder jansi(boolean jansi) Enables or disables the `PROP_PROVIDER_JANSI`/`jansi` terminal provider. If not specified, the system property `PROP_JANSI` will be used if set. If not specified, the provider will be checked.

jna	back to summary
public TerminalBuilder jna(boolean jna) Enables or disables the `PROP_PROVIDER_JNA`/`jna` terminal provider. If not specified, the system property `PROP_JNA` will be used if set. If not specified, the provider will be checked.

jni	back to summary
public TerminalBuilder jni(boolean jni) Enables or disables the `PROP_PROVIDER_JNI`/`jni` terminal provider. If not specified, the system property `PROP_JNI` will be used if set. If not specified, the provider will be checked.

load	back to summary
private static <S> S load(Class<S> clazz)

name	back to summary
public TerminalBuilder name(String name)

nativeSignals	back to summary
public TerminalBuilder nativeSignals(boolean nativeSignals)

paused back to summary

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:boolean: the initial paused state

Returns:TerminalBuilder

The builder

See Also

Terminal#pause()

provider back to summary

public TerminalBuilder provider(String provider)

Forces the usage of the give terminal provider.

Parameters

provider:String: The TerminalProvider's name to use when creating the Terminal.

Returns:TerminalBuilder

The builder.

providers back to summary

public TerminalBuilder providers(String providers)

Sets the list of providers to try when creating the terminal. If not specified, the system property PROP_PROVIDERS will be used if set. Else, the value PROP_PROVIDERS_DEFAULT will be used.

Parameters

providers:String: The list of TerminalProvider's names to check when creating the Terminal.

Returns:TerminalBuilder

The builder.

select	back to summary
private SystemStream select(Map<SystemStream, Boolean> system, TerminalBuilder.SystemOutput systemOutput)

select	back to summary
private static SystemStream select(Map<SystemStream, Boolean> system, SystemStream... streams)

setTerminalOverride back to summary

public static void setTerminalOverride(final Terminal terminal)

Deprecated

Allows an application to override the result of build(). 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 the LineReader of the Terminal. For example, the sbt build tool uses a LineReader to implement an interactive shell. One of its supported commands is console which invokes the scala REPL. The scala REPL also uses a LineReader and it is necessary to override the Terminal used by the the REPL to share the same Terminal instance used by sbt.

When this method is called with a non-null Terminal, all subsequent calls to build() will return the provided Terminal regardless of how the TerminalBuilder was constructed. The default behavior of TerminalBuilder can be restored by calling setTerminalOverride with a null Terminal

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:Terminal: the Terminal to globally override

Annotations

@Deprecated

signalHandler

back to summary

public TerminalBuilder signalHandler(Terminal.SignalHandler signalHandler)

Determines the default value for signal handlers. All signals will be mapped to the given handler.

Parameters

signalHandler:Terminal.SignalHandler: the default signal handler

Returns:TerminalBuilder

The builder

size back to summary

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 the streams(InputStream, OutputStream) method or when system(boolean) has been explicitly called with false.

Parameters

size:Size: the initial size

Returns:TerminalBuilder

The builder

streams	back to summary
public TerminalBuilder streams(InputStream in, OutputStream out)

system	back to summary
public TerminalBuilder system(boolean system)

systemOutput

back to summary

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:TerminalBuilder.SystemOutput: The mode to choose the output stream.

Returns:TerminalBuilder

The builder.

terminal back to summary

public static Terminal terminal() throws IOException

Returns the default system terminal. Terminals should be closed properly using the Terminal#close() method in order to restore the original terminal state.

This call is equivalent to: builder().build()

Returns:Terminal

the default system terminal

Exceptions

IOException:: if an error occurs

type	back to summary
public TerminalBuilder type(String type)

Modifier and Type	Field and Description
public static final TerminalBuilder.SystemOutput	ForcedSysErr
public static final TerminalBuilder.SystemOutput	ForcedSysOut
public static final TerminalBuilder.SystemOutput	SysErr
public static final TerminalBuilder.SystemOutput	SysErrOrSysOut
public static final TerminalBuilder.SystemOutput	SysOut
public static final TerminalBuilder.SystemOutput	SysOutOrSysErr

Modifier and Type	Method and Description
public static TerminalBuilder.SystemOutput	valueOf(String name)
public static TerminalBuilder.SystemOutput[]	values()

public final Class TerminalBuilder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum TerminalBuilder.SystemOutput

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail