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

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

ENGINE_SCOPE

static final int ENGINE_SCOPE

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

См. также:

Значения константного поля

GLOBAL_SCOPE

static final int GLOBAL_SCOPE

Атрибуты GLOBAL_SCOPE видны всем движкам, созданным одной 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, а Bindings не установлен для GLOBAL_SCOPE, то вызов 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 для использования скриптами при отображении вывода.

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

getErrorWriter

Writer getErrorWriter()

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

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

setWriter

void setWriter(Writer writer)

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

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

setErrorWriter

void setErrorWriter(Writer writer)

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

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

getReader

Reader getReader()

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

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

setReader

void setReader(Reader reader)

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

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

getScopes

List<Integer> getScopes()

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

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

© 1993, 2021, 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/17/docs/api/java.scripting/javax/script/ScriptContext.html