MessageTool は国際化されたメッセージの表示に使用します。 文字列は Struts フレームワークのメッセージリソースバンドルから取得されます。 メッセージリソースを操作する以下のメソッドが利用できます。

<tool>
  <key>text</key>
  <scope>request</scope>
  <class>org.apache.velocity.tools.struts.MessageTool</class>
</tool>

Method Overview

get()	指定されたキーに対応する地域化されたメッセージを検索し返却します。
exists()	ユーザのロカールで、指定されたキーに対するメッセージが存在するかどうかをチェックします。
getLocale()	ユーザのロカールを返却します。 ロカールが見つからなかった場合、デフォルトロカールが返却されます。 (推奨されていません。 - VelocityTools 1.2では削除されます。)

指定されたキーに対応する地域化されたメッセージを検索し返却します。

String get(String key)

String get(String key, String bundle)

String get(String key, Object args[])

String get(String key, String bundle, Object args[])

String get(String key, List args)

String get(String key, String bundle, List args)

Parameters

key

メッセージのキー。

bundle

メッセージを保持する(デフォルトではない)メッセージリソースバンドル。

args

メッセージの置換パラメータ。 通常は String の配列、もしくは String を格納した List (String以外でも、適切な toString() メソッドが実装されているオブジェクトなら利用可能) 。

Returns

指定されたキーに対応する地域化されたメッセージ。 キーに対応するメッセージが存在しない場合には null を返却します。

See Also

Struts ユーザガイドの Internationalized Messages。

使用するメッセージの言語を決定するため、ユーザのロカールが参照されます。 3つめ、4つめ、5つめ、6つめのメソッドシグニチャは5つまで置換パラメータを受け取ることが出来ます。 3つめ、4つめのメソッドシグニチャは、既存のアプリケーションとの互換性を提供します。 5つめ、6つめのメソッドシグニチャはよりVelocityで使いやすいものです。

メッセージリソースファイルが以下のメッセージを含んでいる場合:

title=Velocity for Strutsへようこそ
test=このメッセージは5つの置換パラメータがあります: {0}, {1}, {2}, {3}, {4}

以下の Velocity スクリプトは:

$text.get("title")
$text.title
$text.get("test", ["bear", "wolf", "tiger"])

このように出力されます:

Velocity for Strutsへようこそ
Velocity for Strutsへようこそ
このメッセージは5つの置換パラメータがあります: bear, wolf, tiger, {3}, {4}

ユーザのロカールで、指定されたキーに対するメッセージが存在するかどうかをチェックします。

boolean exists(String key)

boolean exists(String key, String bundle)

Parameters

key

メッセージのキー。

bundle

メッセージを保持する(デフォルトではない)メッセージリソースバンドル。

Returns

ユーザのロカールで、メッセージのキーが存在する場合 true 。そうではない場合、 false 。

$text.exists("title")

ユーザのロカールを返却します。 ロカールが見つからなかった場合、デフォルトロカールが返却されます。 (推奨されていません。 - VelocityTools 1.2では削除されます。)

Locale getLocale()

Returns

java.util.Locale クラスのインスタンス。

$text.getLocale()
$text.locale
$text.getLocale().getDisplayLanguage()

は次を生成します:

ja
ja
日本語

返却される Locale クラスのオブジェクトは、 Velocity により toString() メソッドが呼び出され、自動的にレンダリングされます。 3つめの例は Locale クラスの getDisplayLanguage() を呼び出しています。