MessageManagerオブジェクト
コンポーネント情報 | |
---|---|
version | 1.0 |
since | 5.0 |
メッセージを取得するためのAPIです。
メッセージのロケールに関して、2種類のメソッドが用意されています。
例えば、<CONTEXT_PATH>/WEB-INF/conf/message配下に
ロケールの指定がない (3)foo.properties に定義されているメッセージを取得することを意味します。
メッセージのロケールに関して、2種類のメソッドが用意されています。
ユーザのロケールでメッセージを取得するメソッド
- getMessage(String)
- getMessage(String, String...)
以下の解決順序に従ってメッセージを返します。
メッセージを取得する順序
- ユーザのロケールでメッセージを取得。
- テナントのロケールでメッセージを取得。
- システムのデフォルト・ロケールでメッセージを取得。
- ロケール指定のないメッセージpropertiesファイルからメッセージを取得。
- ユーザのロケールで「未定義」の意味を表す文字列を返す。
- 文字列 "undefined" を返す。
指定されたロケールでメッセージを取得するメソッド
- getLocaleMessage(String, String)
- getLocaleMessage(String, String, String...)
以下の解決順序に従ってメッセージを返します。
メッセージを取得する順序
- 指定したロケールでメッセージを取得。
- ロケール指定のないメッセージpropertiesファイルからメッセージを取得。
- 文字列 "undefined" を返す。
例えば、<CONTEXT_PATH>/WEB-INF/conf/message配下に
- (1)foo_en.properties
- (2)foo_ja.properties
- (3)foo.properties
ロケールの指定がない (3)foo.properties に定義されているメッセージを取得することを意味します。
メソッドの概要
返却値の型 | メソッド名 |
---|---|
String | getLocaleMessage (String locale , String key , Object args... ) static国際化されたメッセージを取得します。 |
String | getMessage (String key , Object args... ) staticメッセージを取得します。 |
Boolean | hasLocaleMessage (String locale , String key ) staticメッセージが存在するかどうかを判断します。 |
Boolean | hasMessage (String key ) staticメッセージが存在するかどうかを判断します。 |
メソッドの詳細
String getLocaleMessage (String locale , String key , Object args... )
static
国際化されたメッセージを取得します。
引数に指定したロケールでメッセージを取得します。 メッセージ取得順序の詳細は、MessageManagerオブジェクトの概要に記載されている こちら を参照してください。 置換文字列(メッセージ引数)の挿入は MessageFormat#format(java.lang.String, java.lang.Object[])に準じます。 よってメッセージIDにより取得されるメッセージの内容を上記メソッドの第1引数に渡して処理しますので、 対応するメッセージの内容(propertiesファイルの内容)は、MessageFormatのpattern文字列に沿ったメッセージを記述してください。 置換文字列(メッセージ引数)を利用した場合,取得結果に対して "'"を表現するには"''" "{"を表現するには"'{" を対象のメッセージに記述してください。 メッセージ引数を指定しなかった場合、MessageFormat#format関数を利用しませんので、取得したメッセージを変換せずにそのまま返却します。
パラメータ
返却値
|
String getMessage (String key , Object args... )
static
メッセージを取得します。
現在ログインしているユーザのロケールでメッセージを取得します。 メッセージ取得順序の詳細は、MessageManagerオブジェクトの概要に記載されている こちら を参照してください。 置換文字列(メッセージ引数)の挿入は MessageFormat#format(java.lang.String, java.lang.Object[])に準じます。 よってメッセージIDにより取得されるメッセージの内容を上記メソッドの第1引数に渡して処理しますので、 対応するメッセージの内容(propertiesファイルの内容)は、MessageFormatのpattern文字列に沿ったメッセージを記述してください。 置換文字列(メッセージ引数)を利用した場合,取得結果に対して "'"を表現するには"''" "{"を表現するには"'{" を対象のメッセージに記述してください。 メッセージ引数を指定しなかった場合、MessageFormat#format関数を利用しませんので、取得したメッセージを変換せずにそのまま返却します。
パラメータ
返却値
|
Boolean hasLocaleMessage (String locale , String key )
static
メッセージが存在するかどうかを判断します。
getLocaleMessage(String, String) で取得できるメッセージが存在するかどうかを判断します。 指定されたロケールが存在しない場合はfalse が返ります。
パラメータ
返却値
|
Boolean hasMessage (String key )
static
メッセージが存在するかどうかを判断します。
getMessage(String) で取得できるメッセージが存在するかどうかを判断します。
パラメータ
返却値
|