Spec-Zone.ru › OpenJDK 8

Интерфейс ScriptEngineFactory


public interface ScriptEngineFactory

ScriptEngineFactory используется для описания и создания экземпляров ScriptEngines.

Каждый класс, реализующий ScriptEngine имеет соответствующую фабрику, которая предоставляет метаданные, описывающие класс движка.

ScriptEngineManager использует механизм поставщика сервисов, описанный в Спецификации файлов JAR, для получения экземпляров всех ScriptEngineFactories , доступных в текущем ClassLoader.

С:
1.6

Методы

Модификатор и Тип Метод и Описание
String getEngineName()

Возвращает полное имя ScriptEngine.

String getEngineVersion()

Возвращает версию ScriptEngine.

List<String> getExtensions()

Возвращает неизменяемый список расширений файлов, которые обычно идентифицируют скрипты, написанные на языке, поддерживаемом этим ScriptEngine.

String getLanguageName()

Возвращает имя языка сценариев, поддерживаемого этим ScriptEngine.

String getLanguageVersion()

Возвращает версию языка сценариев, поддерживаемого этим ScriptEngine.

String getMethodCallSyntax(String obj, String m, String... args)

Возвращает строку, которую можно использовать для вызова метода объекта Java с помощью синтаксиса поддерживаемого языка сценариев.

List<String> getMimeTypes()

Возвращает неизменяемый список MIME-типов, связанных со скриптами, которые могут быть выполнены движком.

List<String> getNames()

Возвращает неизменяемый список коротких имен для ScriptEngine, которые могут использоваться для идентификации ScriptEngine ScriptEngineManager.

String getOutputStatement(String toDisplay)

Возвращает строку, которая может использоваться как оператор для отображения указанной строки с помощью синтаксиса поддерживаемого языка сценариев.

Object getParameter(String key)

Возвращает значение атрибута, смысл которого может быть специфичным для реализации.

String getProgram(String... statements)

Возвращает допустимую программу для языка сценариев с заданными операторами.

ScriptEngine getScriptEngine()

Возвращает экземпляр ScriptEngine , связанный с этим ScriptEngineFactory.

Методы

getEngineName

String getEngineName()

Возвращает полное имя ScriptEngine . Например, реализация, основанная на движке Javascript Mozilla Rhino, может вернуть Rhino Mozilla Javascript Engine.

Возвращает:
Имя реализации движка.

getEngineVersion

String getEngineVersion()

Возвращает версию ScriptEngine.

Возвращает:
Версию реализации ScriptEngine.

getExtensions

List<String> getExtensions()

Возвращает неизменяемый список расширений файлов, которые обычно идентифицируют скрипты, написанные на языке, поддерживаемом этим ScriptEngine. Массив используется ScriptEngineManager для реализации метода getEngineByExtension.

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

getMimeTypes

List<String> getMimeTypes()

Возвращает неизменяемый список MIME-типов, связанных со скриптами, которые могут быть выполнены движком. Список используется классом ScriptEngineManager для реализации метода getEngineByMimetype.

Возвращает:
Список MIME-типов.

getNames

List<String> getNames()

Возвращает неизменяемый список коротких имен для ScriptEngine, которые могут использоваться для идентификации ScriptEngine ScriptEngineManager. Например, реализация, основанная на движке Mozilla Rhino Javascript, может вернуть список, содержащий {"javascript", "rhino"}.

Возвращает:
неизменяемый список коротких имен

getLanguageName

String getLanguageName()

Возвращает имя языка сценариев, поддерживаемого этим ScriptEngine.

Возвращает:
Имя поддерживаемого языка.

getLanguageVersion

String getLanguageVersion()

Возвращает версию языка сценариев, поддерживаемого этим ScriptEngine.

Возвращает:
Версия поддерживаемого языка.

getParameter

Object getParameter(String key)

Возвращает значение атрибута, смысл которого может быть специфичным для реализации. Ключи, значения которых определены во всех реализациях:

  • ScriptEngine.ENGINE
  • ScriptEngine.ENGINE_VERSION
  • ScriptEngine.LANGUAGE
  • ScriptEngine.LANGUAGE_VERSION
  • ScriptEngine.NAME

Значения для этих ключей — строки, возвращаемые getEngineName, getEngineVersion, getLanguageName, getLanguageVersion для первых четырех ключей соответственно. Для NAME возвращается одна из строк, возвращаемых getNames.

Зарезервированный ключ THREADING, значение которого описывает поведение движка по отношению к одновременной выполнению скриптов и поддержанию состояния, также определен. Эти значения для ключа THREADING:

  • null — реализация движка не потокобезопасна и не может использоваться для выполнения скриптов одновременно на нескольких потоках.
  • "MULTITHREADED" — реализация движка внутренне потокобезопасна, и скрипты могут выполняться одновременно, хотя эффекты выполнения скрипта в одном потоке могут быть видны скриптам в других потоках.
  • "THREAD-ISOLATED" — реализация удовлетворяет требованиям "MULTITHREADED", а также движок поддерживает независимые значения для символов в скриптах, выполняемых в разных потоках.
  • "STATELESS" — реализация удовлетворяет требованиям
  • "THREAD-ISOLATED". Кроме того, выполнение скриптов не изменяет сопоставления в Bindings, что является областью действия движка ScriptEngine. В частности, ключи в Bindings и их соответствующие значения одинаковы до и после выполнения скрипта.


Реализации могут определять специфичные для реализации ключи.
Параметры:
key — имя параметра
Возвращает:
Значение для данного параметра. Возвращает null если ключу не присвоено значение.

getMethodCallSyntax

String getMethodCallSyntax(String obj,
                           String m,
                           String... args)

Возвращает строку, которую можно использовать для вызова метода объекта Java с помощью синтаксиса поддерживаемого языка сценариев. Например, реализация для движка Javascript может быть;

public String getMethodCallSyntax(String obj,
                                   String m, String... args) {
      String ret = obj;
      ret += "." + m + "(";
      for (int i = 0; i < args.length; i++) {
          ret += args[i];
          if (i < args.length - 1) {
              ret += ",";
          }
      }
      ret += ")";
      return ret;
 }

Параметры:
obj — имя, представляющее объект, метод которого должен быть вызван. Имя используется для создания привязок с помощью метода put ScriptEngine, метода put ENGINE_SCOPE Bindings, или метода setAttribute ScriptContext . Идентификатор, используемый в скриптах, может быть декоративной формой указанного.
m — имя вызываемого метода.
args — имена аргументов в вызове метода.
Возвращает:
Строка, используемая для вызова метода в синтаксисе языка сценариев.

getOutputStatement

String getOutputStatement(String toDisplay)

Возвращает строку, которая может использоваться как оператор для отображения указанной строки с помощью синтаксиса поддерживаемого языка сценариев. Например, реализация для движка Perl может быть;

public String getOutputStatement(String toDisplay) {
      return "print(" + toDisplay + ")";
 }

Параметры:
toDisplay — строка, которая должна отображаться возвращаемым оператором.
Возвращает:
Строка, используемая для отображения строки в синтаксисе языка сценариев.

getProgram

String getProgram(String... statements)

Возвращает допустимую программу для языка сценариев с заданными операторами. Например, реализация для движка PHP может быть:

public String getProgram(String... statements) {
      String retval = "<?\n";
      int len = statements.length;
      for (int i = 0; i < len; i++) {
          retval += statements[i] + ";\n";
      }
      return retval += "?>";
 }

Параметры:
statements — операторы, которые должны быть выполнены. Может быть результатом вызова методов getMethodCallSyntax и getOutputStatement.
Возвращает:
Программа

getScriptEngine

ScriptEngine getScriptEngine()

Возвращает экземпляр ScriptEngine , связанный с этим ScriptEngineFactory. Обычно возвращается новый ScriptEngine, но реализации могут пулить, разделять или повторно использовать движки.

Возвращает:
Новый экземпляр ScriptEngine.

© 1993, 2020, 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API