Интерфейс JavaShellToolBuilder

static JavaShellToolBuilder builder()

Возвращает:

построитель, который можно использовать для настройки и запуска инструмента jshell

JavaShellToolBuilder in(InputStream cmdIn, InputStream userIn)

Требования к реализации:

Если этот метод не вызывается, поведение должно быть эквивалентно вызову in(System.in, null).

Параметры:

cmdIn — источник ввода команд

userIn — источник ввода для выполнения пользовательского кода или null для получения пользовательского ввода из cmdIn

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder out(PrintStream output)

Требования к реализации:

Если ни один из методов out не вызывается, поведение должно быть эквивалентно вызову out(System.out).

Параметры:

output — назначение для откликов на команды, взаимодействия с консолью и вывода пользовательского кода

Возвращает:

экземпляр JavaShellToolBuilder

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

JavaShellToolBuilder err(PrintStream error)

Требования к реализации:

Если ни один из методов err не вызывается, поведение должно быть эквивалентно вызову err(System.err).

Параметры:

error — назначение для ошибок инструмента и ошибок пользовательского кода

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder err(PrintStream cmdErr, PrintStream userErr)

Требования к реализации:

Если ни один из методов err не вызывается, поведение должно быть эквивалентно вызову err(System.err, System.err, System.err).

Параметры:

cmdErr — назначение для ошибок запуска инструмента и критических ошибок

userErr — назначение для вывода ошибок пользовательского кода. Например, пользовательский фрагмент System.err.println("Oops") при выполнении Oops направляется в userErr.

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder persistence(Preferences prefs)

Требования к реализации:

Если ни один из методов persistence не вызывается, следует использовать стандартный механизм хранения постоянных данных инструмента.

Параметры:

prefs — экземпляр Preferences, используемый для получения и хранения постоянной информации

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder persistence(Map<String,String> prefsMap)

Требования к реализации:

Если ни один из методов persistence не вызывается, следует использовать стандартный механизм хранения постоянных данных инструмента.

Параметры:

prefsMap — экземпляр Map, используемый для получения и хранения постоянной информации

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder env(Map<String,String> vars)

Требования к реализации:

Если этот метод не вызывается, поведение должно быть эквивалентно вызову env(System.getenv()).

Параметры:

vars — карта имен переменных среды и их значений

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder locale(Locale locale)

Требования к реализации:

Если этот метод не вызывается, поведение должно быть эквивалентно вызову locale(Locale.getDefault()).

Параметры:

locale — локаль

Возвращает:

экземпляр JavaShellToolBuilder

JavaShellToolBuilder promptCapture(boolean capture)

Требования к реализации:

Если этот метод не вызывается, поведение должно быть эквивалентно вызову promptCapture(false).

Параметры:

capture — если true, основное приглашение — символ ENQ, а приглашение продолжения — символ ACK. Если false, используются приглашения, заданные при настройке или пользовательскими командами /set.

Возвращает:

экземпляр JavaShellToolBuilder

default JavaShellToolBuilder interactiveTerminal(boolean terminal)

Требования к реализации:

Если этот метод не вызывается, поведение должно быть эквивалентно вызову interactiveTerminal(false). Реализация этого метода по умолчанию возвращает this.

Параметры:

terminal — если true, предполагается, что вывод интерпретируется терминалом, способным обрабатывать управляющие последовательности ANSI. Если false, выбирается более простой формат вывода.

Возвращает:

экземпляр JavaShellToolBuilder

Начиная с:

17

default JavaShellToolBuilder windowSize(int columns, int rows)

Требования к реализации:

Реализации могут игнорировать этот метод. Реализация этого метода по умолчанию возвращает this.

Параметры:

columns — количество отображаемых столбцов

rows — количество отображаемых строк

Возвращает:

экземпляр JavaShellToolBuilder

Начиная с:

24

void run(String... arguments) throws Exception

Параметры:

arguments — аргументы командной строки (включая параметры), если они есть

Вызывает исключение:

Exception — непредвиденное критическое исключение

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

Требования к реализации:

Реализация по умолчанию всегда возвращает ноль. Реализациям этого интерфейса следует переопределить этот метод, возвращая статус завершения.

Параметры:

arguments — аргументы командной строки (включая параметры), если они есть

Возвращает:

статус завершения, с которым инструмент явно завершил работу (если таковой имеется); в противном случае 0 при успешном выполнении или 1 при ошибке

Вызывает исключение:

Exception — непредвиденное критическое исключение

Начиная с:

10