Интерфейс ScriptContext

Все известные реализующие классы:: SimpleScriptContext

public interface ScriptContext

Интерфейс, реализующие классы которого используются для подключения Script Engines к объектам, таким как scoped Bindings, в приложениях-хостах. Каждый scope представляет собой набор именованных атрибутов, значения которых можно устанавливать и извлекать с помощью методов ScriptContext. ScriptContexts также предоставляют Readers и Writers, которые могут использоваться ScriptEngines для ввода и вывода.

С тех пор:: 1.6

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`ENGINE_SCOPE`	Атрибуты EngineScope видны в течение всего срока жизни одного `ScriptEngine` и для каждого движка поддерживается набор атрибутов.
`static final int`	`GLOBAL_SCOPE`	Атрибуты GlobalScope видны всем движкам, созданным одним ScriptEngineFactory.

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

Модификатор и тип	Метод	Описание
`Object`	`getAttribute(String name)`	Возвращает значение атрибута с заданным именем в scope, который появляется раньше в порядке поиска.
`Object`	`getAttribute(String name, int scope)`	Получает значение атрибута в заданном scope.
`int`	`getAttributesScope(String name)`	Получает самый низкий scope, в котором определен атрибут.
`Bindings`	`getBindings(int scope)`	Получает `Bindings`, связанный с заданным scope в данном `ScriptContext`.
`Writer`	`getErrorWriter()`	Возвращает `Writer`, используемый для отображения сообщений об ошибках.
`Reader`	`getReader()`	Возвращает `Reader` для чтения входных данных скриптом.
`List<Integer>`	`getScopes()`	Возвращает неизменяемый `List` всех допустимых значений scope в ScriptContext.
`Writer`	`getWriter()`	Возвращает `Writer` для использования скриптами при отображении вывода.
`Object`	`removeAttribute(String name, int scope)`	Удаляет атрибут в заданном scope.
`void`	`setAttribute(String name, Object value, int scope)`	Устанавливает значение атрибута в заданном scope.
`void`	`setBindings(Bindings bindings, int scope)`	Связывает экземпляр `Bindings` с определенным scope в данном `ScriptContext`.
`void`	`setErrorWriter(Writer writer)`	Устанавливает `Writer` для отображения сообщений об ошибках.
`void`	`setReader(Reader reader)`	Устанавливает `Reader` для чтения входных данных скриптами.
`void`	`setWriter(Writer writer)`	Устанавливает `Writer` для использования скриптами при отображении вывода.

Подробное описание полей

ENGINE_SCOPE

static final int ENGINE_SCOPE

Атрибуты EngineScope видны в течение жизни одного ScriptEngine и набор атрибутов поддерживается для каждого движка.

См. также:

GLOBAL_SCOPE

static final int GLOBAL_SCOPE

Атрибуты GlobalScope видны для всех движков, созданных той же ScriptEngineFactory.

См. также:

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

setBindings

void setBindings(Bindings bindings, int scope)

Связывает экземпляр Bindings с определённым scope в этом ScriptContext. Вызовы методов getAttribute и setAttribute должны соответствовать методам get и put объекта Bindings для указанного scope.

Параметры:: bindings - Bindings для связывания с данным scope; scope - scope
Исключения:: IllegalArgumentException - Если для указанного значения scope в ScriptContexts этого типа не определён Bindings.; NullPointerException - если значение scope равно ENGINE_SCOPE и указанный Bindings равен null.

getBindings

Bindings getBindings(int scope)

Получает Bindings , связанный с данным scope в этом ScriptContext.

Параметры:: scope - scope
Возвращает:: Связанное Bindings. Возвращает null если оно не было установлено.
Исключения:: IllegalArgumentException - Если для указанного значения scope в ScriptContext этого типа не определён Bindings.

setAttribute

void setAttribute(String name, Object value, int scope)

Устанавливает значение атрибута в заданном scope. Если scope равен GLOBAL_SCOPE и для GLOBAL_SCOPE не установлен Bindings, то вызов setAttribute игнорируется.

Параметры:: name - Имя атрибута для установки; value - Значение атрибута; scope - scope для установки атрибута
Исключения:: IllegalArgumentException - Если имя пустое или scope некорректный.; NullPointerException - Если имя равно null.

getAttribute

Object getAttribute(String name, int scope)

Получает значение атрибута в заданном scope.

Параметры:: name - Имя атрибута для получения.; scope - scope для получения атрибута.
Возвращает:: Значение атрибута. Возвращает null если имя не существует в данном scope.
Исключения:: IllegalArgumentException - Если имя пустое или значение scope некорректное.; NullPointerException - Если имя равно null.

removeAttribute

Object removeAttribute(String name, int scope)

Удаляет атрибут в заданном scope.

Параметры:: name - Имя атрибута для удаления; scope - scope для удаления атрибута
Возвращает:: Удаленное значение.
Исключения:: IllegalArgumentException - Если имя пустое или scope некорректный.; NullPointerException - Если имя равно null.

getAttribute

Object getAttribute(String name)

Получает значение атрибута с данным именем в scope, который встречается первым в порядке поиска. Порядок определяется числовым значением параметра scope (наименьшие значения scope сначала).

Параметры:: name - Имя атрибута для получения.
Возвращает:: Значение атрибута в наименьшем scope, для которого определён атрибут с данным именем. Возвращает null, если атрибут с данным именем не существует ни в одном scope.
Исключения:: NullPointerException - Если имя равно null.; IllegalArgumentException - Если имя пустое.

getAttributesScope

int getAttributesScope(String name)

Получает наименьший scope, в котором определён атрибут.

Параметры:: name - Имя атрибута.
Возвращает:: Наименьший scope. Возвращает -1, если атрибут с данным именем не определён ни в одном scope.
Исключения:: NullPointerException - Если имя равно null.; IllegalArgumentException - Если имя пустое.

getWriter

Writer getWriter()

Возвращает Writer для использования скриптами при отображении вывода.

Возвращает:: The Writer.

getErrorWriter

Writer getErrorWriter()

Возвращает Writer для отображения выходных данных об ошибках.

Возвращает:: The Writer

setWriter

void setWriter(Writer writer)

Устанавливает Writer для использования скриптами при отображении вывода.

Параметры:: writer - Новый Writer.

setErrorWriter

void setErrorWriter(Writer writer)

Устанавливает Writer для отображения выходных данных об ошибках.

Параметры:: writer - Новый Writer.

getReader

Reader getReader()

Возвращает Reader для чтения входных данных скриптом.

Возвращает:: The Reader.

setReader

void setReader(Reader reader)

Устанавливает Reader для чтения входных данных скриптом.

Параметры:: reader - Новый Reader.

getScopes

List<Integer> getScopes()

Возвращает неизменяемый список List всех допустимых значений scope в ScriptContext.

Возвращает:: Список значений scope

© 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/java.scripting/javax/script/ScriptContext.html