net.skirnir.freyja
インタフェース VariableResolver

既知の実装クラスの一覧:

VariableResolverChain, VariableResolverImpl

public interface VariableResolver

同期化： このインタフェースの実装クラスはスレッドセーフである必要はありません。

作成者:

YOKOTA Takehiko

入れ子クラスの概要

static interface

VariableResolver.Entry

メソッドの概要

boolean	containsVariable(String name) 指定された名前の変数をこのVariableResolverが持っているかを返します。
Object	getVariable(TemplateContext context, String name) 指定された名前の変数の値を返します。
VariableResolver.Entry	getVariableEntry(TemplateContext context, String name) 指定された名前の変数に対応するエントリを返します。
String[]	getVariableNames() このVariableResolverが知っている全ての変数名を返します。
void	removeVariable(String name) このVariableResolverから変数を除去します。
void	setVariable(String name, Object value) このVariableResolverに変数の値を設定します。

メソッドの詳細

getVariable

public Object getVariable(TemplateContext context,
                          String name)

指定された名前の変数の値を返します。

指定された名前の変数が存在しない場合はnullを返します。

パラメータ:

context - 現在のコンテキスト。

name - 変数名。

戻り値:

変数の値。

setVariable

public void setVariable(String name,
                        Object value)

このVariableResolverに変数の値を設定します。

値としてnullを設定することもできます。

パラメータ:

name - 変数名。nullを指定することはできません。

value - 値。

removeVariable

public void removeVariable(String name)

このVariableResolverから変数を除去します。

パラメータ:

name - 変数名。nullを指定することはできません。

containsVariable

public boolean containsVariable(String name)

指定された名前の変数をこのVariableResolverが持っているかを返します。

パラメータ:

name - 変数名。nullを指定することはできません。

戻り値:

変数を持っているかどうか。

getVariableNames

public String[] getVariableNames()

このVariableResolverが知っている全ての変数名を返します。

変数名には、登録されていて値が存在する変数の名前の他に、 値は登録されていない組み込み変数の名前が含まれます。

戻り値:

変数名の配列。nullが返されることはありません。

getVariableEntry

public VariableResolver.Entry getVariableEntry(TemplateContext context,
                                               String name)

指定された名前の変数に対応するエントリを返します。

指定された名前の変数をVariableResolverが持たない場合はnullを返します。

パラメータ:

context - 現在のコンテキスト。

name - 変数名。

戻り値:

Entryオブジェクト。