Интерфейс JavaShellToolBuilder

public interface JavaShellToolBuilder

Интерфейс для конфигурирования и запуска экземпляра Java shell инструмента. Экземпляр билдера создаётся с помощью статического метода builder(). Этот билдер, по желанию, можно настроить с помощью методов конфигурации. Все методы конфигурации возвращают экземпляр билдера для использования в цепочке инициализации. Все методы конфигурации имеют разумные значения по умолчанию, которые будут использованы, если они не вызваны. После нуля или более вызовов методов конфигурации инструмент запускается с помощью вызова run(java.lang.String...).

Since:: 9

Краткое описание методов

Модификатор и тип	Метод	Описание
`static JavaShellToolBuilder`	`builder()`	Создать билдер для запуска инструмента JDK jshell.
`JavaShellToolBuilder`	`env(Map<String,String> vars)`	Установить источник для переменных среды.
`JavaShellToolBuilder`	`err(PrintStream error)`	Установить каналы ошибок.
`JavaShellToolBuilder`	`err(PrintStream cmdErr, PrintStream userErr)`	Установить каналы ошибок.
`JavaShellToolBuilder`	`in(InputStream cmdIn, InputStream userIn)`	Установить каналы ввода.
`default JavaShellToolBuilder`	`interactiveTerminal(boolean terminal)`	Установить значение в true, чтобы указать, что ввод и вывод подключены к интерактивному терминалу, который может интерпретировать коды ANSI.
`JavaShellToolBuilder`	`locale(Locale locale)`	Установить локаль.
`JavaShellToolBuilder`	`out(PrintStream output)`	Установить каналы вывода.
`JavaShellToolBuilder`	`out(PrintStream cmdOut, PrintStream console, PrintStream userOut)`	Установить каналы вывода.
`JavaShellToolBuilder`	`persistence(Map<String,String> prefsMap)`	Установить механизм хранения постоянной информации, которая включает историю ввода и сохранённые настройки.
`JavaShellToolBuilder`	`persistence(Preferences prefs)`	Установить механизм хранения постоянной информации, которая включает историю ввода и сохранённые настройки.
`JavaShellToolBuilder`	`promptCapture(boolean capture)`	Установить для включения переопределения приглашения для захвата команд.
`void`	`run(String... arguments)`	Запустить экземпляр Java shell инструмента, настроенный другими методами в этом интерфейсе.
`default int`	`start(String... arguments)`	Запустить экземпляр Java shell инструмента, настроенный другими методами в этом интерфейсе.

Подробное описание методов

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. Если false, запросы устанавливаются с помощью команд настройки или пользовательских /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

run

void run(String... arguments) throws Exception

Запустить экземпляр инструмента Java shell, настроенного другими методами в этом интерфейсе. Этот вызов не разрушительный; этот метод можно вызывать несколько раз из настроенного конструктора. Код завершения инструмента Java shell игнорируется.

Параметры:: arguments - аргументы командной строки (включая опции), если таковые имеются
Исключения:: Exception - непредвиденное критическая ошибка

start

default int start(String... arguments) throws Exception

Требования к реализации:: По умолчанию всегда возвращает ноль. Реализации этого интерфейса должны переопределять этот метод, возвращая код завершения.
Параметры:: arguments - аргументы командной строки (включая опции), если таковые имеются
Возвращает:: код завершения, с которым инструмент явно завершился (если таковой имеется), иначе 0 для успеха или 1 для неудачи
Исключения:: Exception - непредвиденное критическая ошибка

© 1993, 2023, 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://docs.oracle.com/en/java/javase/21/docs/api/jdk.jshell/jdk/jshell/tool/JavaShellToolBuilder.html