com.github.mygreen.supercsv.localization

クラス MessageInterpolator

java.lang.Object

com.github.mygreen.supercsv.localization.MessageInterpolator

public class MessageInterpolator
extends Object

名前付き変数のメッセージをフォーマットするクラス。

{...}の場合、変数を単純に置換する。

${...}の場合、EL式を利用し処理する。

文字'$', '{', '}'は特殊文字のため、\でエスケープを行う。

ELのパーサは、ExpressionLanguageの実装クラスで切り替え可能。

MessageResolverを指定した場合、メッセージ中の変数{...}をメッセージ定義コードとして解決する。 ただし、メッセージ変数で指定されている変数が優先される。

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MessageInterpolator() デフォルトのコンストラクタ 式言語の処理実装として、JEXLのExpressionLanguageJEXLImpl が設定されます。
MessageInterpolator(ExpressionLanguage expressionLanguage) 式言語の実装を指定するコンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected String	evaluateExpression(String expression, Map<String,?> values) EL式を評価する。
ExpressionLanguage	getExpressionLanguage() EL式を解析する実装クラスを取得する。
String	interpolate(String message, Map<String,?> vars) メッセージを引数varsで指定した変数で補完する。
String	interpolate(String message, Map<String,?> vars, boolean recursive) メッセージを引数varsで指定した変数で補完する。
String	interpolate(String message, Map<String,?> vars, boolean recursive, MessageResolver messageResolver) メッセージを引数varsで指定した変数で補完する。
protected String	parse(String message, Map<String,?> vars, boolean recursive, MessageResolver messageResolver) メッセージをパースし、変数に値を差し込み、EL式を評価する。
void	setExpressionLanguage(ExpressionLanguage expressionLanguage) EL式を解析する実装クラスを設定する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

MessageInterpolator

public MessageInterpolator()

デフォルトのコンストラクタ

式言語の処理実装として、JEXLのExpressionLanguageJEXLImpl が設定されます。
さらに、関数としてCustomFunctionsが登録されており、接頭語 f:で呼び出し可能です。

MessageInterpolator

public MessageInterpolator(ExpressionLanguage expressionLanguage)

式言語の実装を指定するコンストラクタ

パラメータ:

expressionLanguage - EL式を評価する実装。

メソッドの詳細

interpolate

public String interpolate(String message,
                          Map<String,?> vars)

メッセージを引数varsで指定した変数で補完する。

パラメータ:

message - 対象のメッセージ。

vars - メッセージ中の変数に対する値のマップ。

戻り値:

補完したメッセージ。

interpolate

public String interpolate(String message,
                          Map<String,?> vars,
                          boolean recursive)

メッセージを引数varsで指定した変数で補完する。

パラメータ:

message - 対象のメッセージ。

vars - メッセージ中の変数に対する値のマップ。

recursive - 変換したメッセージに対しても再帰的に処理するかどうか

戻り値:

補完したメッセージ。

interpolate

public String interpolate(String message,
                          Map<String,?> vars,
                          boolean recursive,
                          MessageResolver messageResolver)

メッセージを引数varsで指定した変数で補完する。

MessageResolverを指定した場合、メッセージ中の変数をメッセージコードとして解決します。

パラメータ:

message - 対象のメッセージ。

vars - メッセージ中の変数に対する値のマップ。

recursive - 変換したメッセージに対しても再帰的に処理するかどうか

messageResolver - メッセージを解決するクラス。nullの場合、指定しないと同じ意味になります。

戻り値:

補完したメッセージ。

parse

protected String parse(String message,
                       Map<String,?> vars,
                       boolean recursive,
                       MessageResolver messageResolver)

メッセージをパースし、変数に値を差し込み、EL式を評価する。

パラメータ:

message - 対象のメッセージ。

vars - メッセージ中の変数に対する値のマップ。

messageResolver - メッセージを解決するクラス。nullの場合、指定しないと同じ意味になります。

戻り値:

補完したメッセージ。

evaluateExpression

protected String evaluateExpression(String expression,
                                    Map<String,?> values)
                             throws ExpressionEvaluationException

EL式を評価する。

パラメータ:

expression - EL式

values - EL式中の変数。

戻り値:

評価した式。

例外:

ExpressionEvaluationException

getExpressionLanguage

public ExpressionLanguage getExpressionLanguage()

EL式を解析する実装クラスを取得する。

戻り値:

setExpressionLanguage

public void setExpressionLanguage(ExpressionLanguage expressionLanguage)

EL式を解析する実装クラスを設定する。

パラメータ:

expressionLanguage - EL式の解析するクラスの実装。