Интерфейс JavaShellToolBuilder
public interface JavaShellToolBuilder
Интерфейс для настройки и запуска экземпляра утилиты Java shell. Экземпляр билдера создается с помощью статического метода
builder(). Этот билдер может быть настроен с помощью методов конфигурации. Все методы конфигурации возвращают экземпляр билдера для использования в цепочке инициализации. Все методы конфигурации имеют разумные значения по умолчанию, которые будут использоваться, если они не вызываются. После нуля или более вызовов методов конфигурации инструмент запускается с помощью вызова run(java.lang.String...).- С момента:
- 9
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
static JavaShellToolBuilder |
builder() |
Создать билдер для запуска инструмента JDK jshell. |
JavaShellToolBuilder |
env |
Установить источник для переменных среды. |
JavaShellToolBuilder |
err |
Установить каналы ошибок. |
JavaShellToolBuilder |
err |
Установить каналы ошибок. |
JavaShellToolBuilder |
in |
Установить каналы ввода. |
default JavaShellToolBuilder |
interactiveTerminal |
Установить значение в true для указания того, что ввод и вывод подключены к интерактивной терминальной оболочке, которая может интерпретировать управляющие последовательности ANSI. |
JavaShellToolBuilder |
locale |
Установить локаль. |
JavaShellToolBuilder |
out |
Установить каналы вывода. |
JavaShellToolBuilder |
out |
Установить каналы вывода. |
JavaShellToolBuilder |
persistence |
Установить механизм хранения постоянной информации, которая включает историю ввода и сохраненные настройки. |
JavaShellToolBuilder |
persistence |
Установить механизм хранения постоянной информации, которая включает историю ввода и сохраненные настройки. |
JavaShellToolBuilder |
promptCapture |
Установить для включения переопределения подсказки ввода команды. |
void |
run |
Запустить экземпляр инструмента Java shell, настроенный другими методами в этом интерфейсе. |
default int |
start |
Запустить экземпляр инструмента Java shell, настроенный другими методами в этом интерфейсе. |
default JavaShellToolBuilder |
windowSize |
Указать размер окна дисплея при использовании интерактивной терминальной оболочки. |
Подробное описание методов
builder
static JavaShellToolBuilder builder()
Создать конструктор для запуска инструмента JDK jshell.
- Возвращает:
- конструктор, который можно использовать для настройки и запуска инструмента jshell
in
JavaShellToolBuilder in(InputStream cmdIn, InputStream userIn)
Установить каналы ввода.
- Требования к реализации:
- Если этот метод не вызван, поведение должно быть эквивалентно вызову
in(System.in, null). - Параметры:
-
cmdIn- источник командного ввода -
userIn- источник ввода для выполнения пользовательского кода илиnullдля извлечения пользовательского ввода из cmdIn - Возвращает:
- экземпляр
JavaShellToolBuilder
out
JavaShellToolBuilder out(PrintStream output)
Установить каналы вывода. То же, что и
out(output, output, output).- Требования к реализации:
- Если ни один из методов
outне вызван, поведение должно быть эквивалентно вызовуout(System.out). - Параметры:
-
output- место назначения обратной связи команд, взаимодействия с консолью и вывода пользовательского кода - Возвращает:
- экземпляр
JavaShellToolBuilder
out
JavaShellToolBuilder out(PrintStream cmdOut, PrintStream console, PrintStream userOut)
Установить каналы вывода.
- Требования к реализации:
- Если ни один из методов
outне вызван, поведение должно быть эквивалентно вызовуout(System.out, System.out, System.out). - Параметры:
-
cmdOut- место назначения командной обратной связи, включая сообщения об ошибках для пользователей -
console- место назначения взаимодействия с консолью -
userOut- место назначения вывода пользовательского кода. Например, пользовательский фрагментSystem.out.println("Hello")при выполненииHelloпопадает в userOut. - Возвращает:
- экземпляр
JavaShellToolBuilder
err
JavaShellToolBuilder err(PrintStream error)
Установить каналы ошибок. То же, что и
err(error, error).- Требования к реализации:
- Если ни один из методов
errне вызван, поведение должно быть эквивалентно вызовуerr(System.err). - Параметры:
-
error- место назначения ошибок инструмента и ошибок пользовательского кода - Возвращает:
- экземпляр
JavaShellToolBuilder
err
JavaShellToolBuilder err(PrintStream cmdErr, PrintStream userErr)
Установить каналы ошибок.
- Требования к реализации:
- Если ни один из методов
errне вызван, поведение должно быть эквивалентно вызовуerr(System.err, System.err, System.err). - Параметры:
-
cmdErr- место назначения ошибок запуска инструмента и фатальных ошибок -
userErr- место назначения вывода ошибок пользовательского кода. Например, пользовательский фрагментSystem.err.println("Oops")при выполненииOopsпопадает в userErr. - Возвращает:
- экземпляр
JavaShellToolBuilder
persistence
JavaShellToolBuilder persistence(Preferences prefs)
Установить механизм хранения постоянной информации, включающий историю ввода и сохраненные настройки.
- Требования к реализации:
- Если ни один из методов
persistenceне вызван, поведение должно быть аналогичным стандартному механизму хранения инструмента. - Параметры:
-
prefs- экземплярPreferences, используемый для извлечения и хранения постоянной информации - Возвращает:
- экземпляр
JavaShellToolBuilder
persistence
JavaShellToolBuilder persistence(Map<String,String> prefsMap)
Установить механизм хранения постоянной информации, включающий историю ввода и сохраненные настройки.
- Требования к реализации:
- Если ни один из методов
persistenceне вызван, поведение должно быть аналогичным стандартному механизму хранения инструмента. - Параметры:
-
prefsMap- экземплярMap, используемый для извлечения и хранения постоянной информации - Возвращает:
- экземпляр
JavaShellToolBuilder
env
JavaShellToolBuilder env(Map<String,String> vars)
Установить источник для переменных среды.
- Требования к реализации:
- Если этот метод не вызван, поведение должно быть эквивалентно вызову
env(System.getenv()). - Параметры:
-
vars- карта имён переменных среды и их значений - Возвращает:
- экземпляр
JavaShellToolBuilder
locale
JavaShellToolBuilder locale(Locale locale)
Установить локаль.
- Требования к реализации:
- Если этот метод не вызван, поведение должно быть эквивалентно вызову
locale(Locale.getDefault()). - Параметры:
-
locale- локаль - Возвращает:
- экземпляр
JavaShellToolBuilder
promptCapture
JavaShellToolBuilder promptCapture(boolean capture)
Установить для включения переопределения командного приглашения для захвата.
- Требования к реализации:
- Если этот метод не вызван, поведение должно быть эквивалентно вызову
promptCapture(false). - Параметры:
-
capture- еслиtrue, базовое приглашение - символENQ, приглашение продолжения - символACK. Если ложь, приглашения задаются командами настройки или пользовательскими/setкомандами. - Возвращает:
- экземпляр
JavaShellToolBuilder
interactiveTerminal
default JavaShellToolBuilder interactiveTerminal(boolean terminal)
Установить значение в true для указания того, что ввод и вывод подключены к интерактивной консоли, способной интерпретировать ANSI-коды. Символы, отправленные в потоки вывода, предполагаются интерпретируемыми консолью и отображаемыми пользователю, а точный порядок и характер символов, отправленных в выводы, не определён. Установить в false для указания устаревшего более простого поведения, чьи выводы могут быть обработаны автоматизированными инструментами. Когда поток ввода для этой Java Shell
System.in, это значение игнорируется, и поведение аналогично указанию true в этом методе, но более точно следует за конкретной консолью, подключенной к System.in.- Требования к реализации:
- Если этот метод не вызван, поведение должно быть эквивалентно вызову
interactiveTerminal(false). По умолчанию этот метод возвращаетthis. - Параметры:
-
terminal- еслиtrue, предполагается, что терминал, способный интерпретировать ANSI-коды, интерпретирует вывод. Еслиfalse, выбирается более простой вывод. - Возвращает:
- экземпляр
JavaShellToolBuilder - С:
- 17
windowSize
default JavaShellToolBuilder windowSize(int columns, int rows)
Предоставить подсказку о размерах окна отображения при использовании интерактивной консоли.
Когда поток ввода для этой Java Shell System.in, это настройка игнорируется.
- Требования к реализации:
- Реализации могут выбрать игнорирование этого метода. По умолчанию этот метод возвращает
this. - Параметры:
-
columns- количество отображаемых столбцов -
rows- количество отображаемых строк - Возвращает:
- экземпляр
JavaShellToolBuilder - С:
- 24
run
void run(String... arguments) throws Exception
Запустить экземпляр инструмента Java Shell, настроенный другими методами в этом интерфейсе. Этот вызов не разрушителен, можно вызвать этот метод несколько раз из настроенного конструктора. Код выхода инструмента Java Shell игнорируется.
- Параметры:
-
arguments- аргументы командной строки (включая опции), если есть - Исключения:
-
Exception- непредвиденное фатальное исключение
start
default int start(String... arguments) throws Exception
Запустить экземпляр инструмента Java Shell, настроенный другими методами в этом интерфейсе. Этот вызов не разрушителен, можно вызвать этот метод несколько раз из настроенного конструктора.
- Требования к реализации:
- По умолчанию всегда возвращает ноль. Реализации этого интерфейса должны переопределить этот метод, возвращая код выхода.
- Параметры:
-
arguments- аргументы командной строки (включая опции), если есть - Возвращает:
- код выхода, с которым инструмент явно завершился (если есть), иначе 0 для успеха или 1 для неудачи
- Исключения:
-
Exception- непредвиденное фатальное исключение - С:
- 10
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/jdk.jshell/jdk/jshell/tool/JavaShellToolBuilder.html
