ScriptTemplateConfigurer (Spring Framework 5.1.5.RELEASE API)

java.lang.Object
- org.springframework.web.servlet.view.script.ScriptTemplateConfigurer

実装されているすべてのインターフェース:
ScriptTemplateConfig
```
public class ScriptTemplateConfigurer
extends java.lang.Object
implements ScriptTemplateConfig
```
Web アプリケーションで使用する ScriptEngine を作成するための Spring MVC の ScriptTemplateConfig の実装。
```
 // Add the following to an @Configuration class
 @Bean
 public ScriptTemplateConfigurer mustacheConfigurer() {
    ScriptTemplateConfigurer configurer = new ScriptTemplateConfigurer();
    configurer.setEngineName("nashorn");
    configurer.setScripts("mustache.js");
    configurer.setRenderObject("Mustache");
    configurer.setRenderFunction("render");
    return configurer;
 }
 
```
注意 : sharedEngine プロパティを false に設定することにより、Handlebars または Nashorn で実行されている React のように、同時実行用に設計されていないテンプレートライブラリで非スレッドセーフスクリプトエンジンを使用できます。
導入:
4.2
作成者:
Sebastien Deleuze
関連事項:
ScriptTemplateView

コンストラクターの概要

コンストラクター
コンストラクターと説明
`ScriptTemplateConfigurer()` デフォルトコンストラクター。
`ScriptTemplateConfigurer(java.lang.String engineName)` 指定されたエンジン名を使用して新しい ScriptTemplateConfigurer を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`java.nio.charset.Charset`	`getCharset()` スクリプトおよびテンプレートファイルの読み取りに使用される文字セットを返します。
`java.lang.String`	`getContentType()` レスポンスに使用するコンテンツ型を返します。
`javax.script.ScriptEngine`	`getEngine()` ビューで使用する `ScriptEngine` を返します。
`java.lang.String`	`getEngineName()` `ScriptEngine` のインスタンス化に使用されるエンジン名を返します。
`java.lang.String`	`getRenderFunction()` レンダリング関数名を返します（オプション）。
`java.lang.String`	`getRenderObject()` render 関数が属するオブジェクトを返します（オプション）。
`java.lang.String`	`getResourceLoaderPath()` Spring リソースの場所を介してリソースローダーのパスを返します。
`java.lang.String[]`	`getScripts()` スクリプトエンジン（ライブラリまたはユーザー指定）によってロードされるスクリプトを返します。
`java.lang.Boolean`	`isSharedEngine()` すべてのスレッドで共有エンジンを使用するか、各スレッドのスレッドローカルエンジンインスタンスを作成するかを返します。
`void`	`setCharset(java.nio.charset.Charset charset)` スクリプトおよびテンプレートファイルの読み取りに使用する文字セットを設定します。
`void`	`setContentType(java.lang.String contentType)` レスポンスに使用するコンテンツ型を設定します。
`void`	`setEngine(javax.script.ScriptEngine engine)` ビューで使用する `ScriptEngine` を設定します。
`void`	`setEngineName(java.lang.String engineName)` `ScriptEngine` のインスタンス化に使用されるエンジン名を設定します。
`void`	`setRenderFunction(java.lang.String renderFunction)` レンダリング関数名を設定します（オプション）。
`void`	`setRenderObject(java.lang.String renderObject)` render 関数が属するオブジェクトを設定します（オプション）。
`void`	`setResourceLoaderPath(java.lang.String resourceLoaderPath)` Spring リソースの場所を介してリソースローダーのパスを設定します。
`void`	`setScripts(java.lang.String... scriptNames)` スクリプトエンジン（ライブラリまたはユーザー指定）によってロードされるスクリプトを設定します。
`void`	`setSharedEngine(java.lang.Boolean sharedEngine)` `false` に設定した場合、単一の共有インスタンスではなく、スレッドローカル `ScriptEngine` インスタンスを使用します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - ScriptTemplateConfigurer
```
public ScriptTemplateConfigurer()
```
    デフォルトコンストラクター。
  - ScriptTemplateConfigurer
```
public ScriptTemplateConfigurer(java.lang.String engineName)
```
    指定されたエンジン名を使用して新しい ScriptTemplateConfigurer を作成します。
- メソッドの詳細
  - setEngine
```
public void setEngine(@Nullable
                      javax.script.ScriptEngine engine)
```
    ビューで使用する ScriptEngine を設定します。renderFunction が指定されている場合、スクリプトエンジンは Invocable を実装する必要があります。engine または engineName の両方ではなく、両方を定義する必要があります。
    sharedEngine フラグが false に設定されている場合、この setter ではスクリプトエンジンを指定するのではなく、setEngineName(String) で指定する必要があります（スクリプトエンジンの複数の遅延インスタンス化を意味するため）。
    関連事項:
    setEngineName(String)
  - getEngine
```
@Nullable
public javax.script.ScriptEngine getEngine()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    ビューで使用する ScriptEngine を返します。
    次で指定:
    インターフェース ScriptTemplateConfig の getEngine
  - setEngineName
```
public void setEngineName(@Nullable
                          java.lang.String engineName)
```
    ScriptEngine のインスタンス化に使用されるエンジン名を設定します。renderFunction が指定されている場合、スクリプトエンジンは Invocable を実装する必要があります。engine または engineName の両方ではなく、両方を定義する必要があります。
    関連事項:
    setEngine(ScriptEngine)
  - getEngineName
```
@Nullable
public java.lang.String getEngineName()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    ScriptEngine のインスタンス化に使用されるエンジン名を返します。
    次で指定:
    インターフェース ScriptTemplateConfig の getEngineName
  - setSharedEngine
```
public void setSharedEngine(@Nullable
                            java.lang.Boolean sharedEngine)
```
    false に設定した場合、単一の共有インスタンスではなく、スレッドローカル ScriptEngine インスタンスを使用します。Nashorn で実行されている Handlebars や React などの同時実行用に設計されていないテンプレートライブラリを備えた非スレッドセーフスクリプトエンジンを使用する場合は、このフラグを false に設定する必要があります。この場合、このバグのため、Java 8u60 以降が必要です。
    このフラグが false に設定されている場合、setEngineName(String) を使用してスクリプトエンジンを指定する必要があります。スクリプトエンジンの複数のインスタンスを遅延して（スレッドごとに 1 つ）作成する必要があるため、setEngine(ScriptEngine) を使用することはできません。
    関連事項:
    THREADING ScriptEngine パラメーターSE
  - isSharedEngine
```
@Nullable
public java.lang.Boolean isSharedEngine()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    すべてのスレッドで共有エンジンを使用するか、各スレッドのスレッドローカルエンジンインスタンスを作成するかを返します。
    次で指定:
    インターフェース ScriptTemplateConfig の isSharedEngine
  - setScripts
```
public void setScripts(@Nullable
                       java.lang.String... scriptNames)
```
    スクリプトエンジン（ライブラリまたはユーザー指定）によってロードされるスクリプトを設定します。resourceLoaderPath のデフォルト値は "classpath:" であるため、クラスパスで使用可能なスクリプトを簡単にロードできます。
    例: WebJars 依存関係およびカスタム "render.js" ファイルとして使用可能な JavaScript ライブラリを使用するには、configurer.setScripts("/META-INF/resources/webjars/library/version/library.js", "com/myproject/script/render.js"); を呼び出す必要があります。
    関連事項:
    setResourceLoaderPath(java.lang.String), WebJars
  - getScripts
```
@Nullable
public java.lang.String[] getScripts()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    スクリプトエンジン（ライブラリまたはユーザー指定）によってロードされるスクリプトを返します。
    次で指定:
    インターフェース ScriptTemplateConfig の getScripts
  - setRenderObject
```
public void setRenderObject(@Nullable
                            java.lang.String renderObject)
```
    render 関数が属するオブジェクトを設定します（オプション）。例: Mustache.render() を呼び出すには、renderObject を "Mustache" に、renderFunction を "render" に設定する必要があります。
  - getRenderObject
```
@Nullable
public java.lang.String getRenderObject()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    render 関数が属するオブジェクトを返します（オプション）。
    次で指定:
    インターフェース ScriptTemplateConfig の getRenderObject
  - setRenderFunction
```
public void setRenderFunction(@Nullable
                              java.lang.String renderFunction)
```
    レンダリング関数名を設定します（オプション）。指定しない場合、スクリプトテンプレートは ScriptEngine.eval(String, Bindings) で評価されます。
    この関数は、次のパラメーターで呼び出されます。
    1. String template: テンプレートの内容
    2. Map model: ビューモデル
    3. RenderingContext context: レンダリングコンテキスト (5.0 以降)
    関連事項:
    RenderingContext
  - getRenderFunction
```
@Nullable
public java.lang.String getRenderFunction()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    レンダリング関数名を返します（オプション）。指定しない場合、スクリプトテンプレートは ScriptEngine.eval(String, Bindings) で評価されます。
    次で指定:
    インターフェース ScriptTemplateConfig の getRenderFunction
  - setContentType
```
public void setContentType(@Nullable
                           java.lang.String contentType)
```
    レスポンスに使用するコンテンツ型を設定します。（デフォルトでは text/html）。
    導入:
    4.2.1
  - getContentType
```
@Nullable
public java.lang.String getContentType()
```
    レスポンスに使用するコンテンツ型を返します。
    次で指定:
    インターフェース ScriptTemplateConfig の getContentType
    導入:
    4.2.1
  - setCharset
```
public void setCharset(@Nullable
                       java.nio.charset.Charset charset)
```
    スクリプトおよびテンプレートファイルの読み取りに使用する文字セットを設定します。（デフォルトでは UTF-8）。
  - getCharset
```
@Nullable
public java.nio.charset.Charset getCharset()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    スクリプトおよびテンプレートファイルの読み取りに使用される文字セットを返します。
    次で指定:
    インターフェース ScriptTemplateConfig の getCharset
  - setResourceLoaderPath
```
public void setResourceLoaderPath(@Nullable
                                  java.lang.String resourceLoaderPath)
```
    Spring リソースの場所を介してリソースローダーのパスを設定します。パスのコンマ区切りリストとして複数の場所を受け入れます。Spring の ResourceLoader で理解されているように、"file:" や "classpath:" などの標準 URL と疑似 URL がサポートされています。ApplicationContext で実行している場合は、相対パスを使用できます。
    デフォルトは "classpath:" です。
  - getResourceLoaderPath
```
@Nullable
public java.lang.String getResourceLoaderPath()
```
    インターフェースからコピーされた説明: ScriptTemplateConfig
    Spring リソースの場所を介してリソースローダーのパスを返します。
    次で指定:
    インターフェース ScriptTemplateConfig の getResourceLoaderPath

クラス ScriptTemplateConfigurer

コンストラクターの概要

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

ScriptTemplateConfigurer

ScriptTemplateConfigurer

メソッドの詳細

setEngine

getEngine

setEngineName

getEngineName

setSharedEngine

isSharedEngine

setScripts

getScripts

setRenderObject

getRenderObject

setRenderFunction

getRenderFunction

setContentType

getContentType

setCharset

getCharset

setResourceLoaderPath

getResourceLoaderPath