org.apache.struts.util
クラス MessageResources

java.lang.Object
  org.apache.struts.util.MessageResources

すべての実装インタフェース:

java.io.Serializable

直系の既知のサブクラス:

PropertyMessageResources

public abstract class MessageResources

extends java.lang.Object

implements java.io.Serializable

明確に定義されていないリソースのロケーションからLocale毎のメッセージを 取得し、MessageFormatクラスを使用して 国際化されたメッセージに対してパラメータ置換を行い 出力するためのAPIを記述した汎用的な目的をもつ抽象クラスです。

Locale の指定無しで getMessage() がコールされた場合、 動作しているJVMのデフォルトの Localeが指定されたと仮定して動作します。

定義されていないキーまたは Locale でgetMessage()がコールされた場合、 returnNull プロパティに true をセットした場合には nullが返され、それ以外の場合には代わりに適当なエラーメッセージが返されます。

実装時の注意 - このクラスのインスタンスが再配布可能なアプリケーションサーバー環境で使用できるように、 このクラスを継承するクラスはSerializableでなくてはなりません。

バージョン:

$Revision: 1.2 $ $Date: 2003/03/22 07:55:10 $

作成者:

Craig R. McClanahan

関連項目:

直列化された形式

翻訳者:

日置 聡 [日本語訳のコメントは、report@jajakarta.orgに送ってください。]

フィールドの概要

protected java.lang.String	config MessageResourcesを初期化する際の設定パラメータ
protected static MessageResourcesFactory	defaultFactory MessageResources インスタンスを生成する際のデフォルトの MessageResourcesFactory
protected java.util.Locale	defaultLocale 現在の環境でのデフォルトのLocale
protected MessageResourcesFactory	factory このインスタンスを生成した MessageResourcesFactory
protected java.util.HashMap	formats 今までに生成された MessageFormat オブジェクトの集合。
protected boolean	returnNull 定義されていない Locale または キーでリクエストをおこなった場合に エラーメッセージの代わりに null を返すか？

コンストラクタの概要

MessageResources(MessageResourcesFactory factory, java.lang.String config)
指定されたパラメータで新規 MessageResources を生成します。

MessageResources(MessageResourcesFactory factory, java.lang.String config, boolean returnNull)
指定されたパラメータで新規 MessageResources を生成します。

メソッドの概要

protected java.lang.String	escape(java.lang.String string) 指定されたメッセージ文字列に含まれるシングルクオート文字のエスケープ処理を行います。
java.lang.String	getConfig()
MessageResourcesFactory	getFactory()
abstract java.lang.String	getMessage(java.util.Locale locale, java.lang.String key) 指定されたキーとLocaleに該当するテキストメッセージを返します。
java.lang.String	getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object[] args) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0, java.lang.Object arg1) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.lang.String key) 指定されたキーに該当するデフォルトLocaleでのテキストメッセージを返します。
java.lang.String	getMessage(java.lang.String key, java.lang.Object arg0) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.lang.String key, java.lang.Object[] args) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
java.lang.String	getMessage(java.lang.String key, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) 指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。
static MessageResources	getMessageResources(java.lang.String config) デフォルトのMessageResourcesFactory を使用して MessageResources インスタンスを生成し、返します。
boolean	getReturnNull()
boolean	isPresent(java.util.Locale locale, java.lang.String key) 指定されたLocaleとキーに対応するメッセージが定義されている場合に true を返します。
boolean	isPresent(java.lang.String key) システムのデフォルトロケールで、指定されたキーに対応するメッセージが定義されている場合に true を返します。
protected java.lang.String	localeKey(java.util.Locale locale) Localeに対応するキャッシュ情報を参照するためのキーを計算し、返します。
void	log(java.lang.String message) 現在の環境に設定されている Writer に対して、メッセージをログ出力します。
void	log(java.lang.String message, java.lang.Throwable throwable) 現在の環境に設定されている Writer に対して、メッセージと例外をログ出力します。
protected java.lang.String	messageKey(java.util.Locale locale, java.lang.String key) Localeとメッセージキーに対応するキャッシュ情報を参照するためのキーを計算し、返します。
protected java.lang.String	messageKey(java.lang.String localeKey, java.lang.String key) Localeキーとメッセージキーに対応するキャッシュ情報を参照するためのキーを計算し、返します。
void	setReturnNull(boolean returnNull)

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

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

フィールドの詳細

config

protected java.lang.String config

MessageResourcesを初期化する際の設定パラメータ

defaultLocale

protected java.util.Locale defaultLocale

現在の環境でのデフォルトのLocale

factory

protected MessageResourcesFactory factory

このインスタンスを生成した MessageResourcesFactory

formats

protected java.util.HashMap formats

今までに生成された MessageFormat オブジェクトの集合。 messageKey()によって計算された値をキーとします。

returnNull

protected boolean returnNull

定義されていない Locale または キーでリクエストをおこなった場合に エラーメッセージの代わりに null を返すか？

defaultFactory

protected static MessageResourcesFactory defaultFactory

MessageResources インスタンスを生成する際のデフォルトの MessageResourcesFactory

コンストラクタの詳細

MessageResources

public MessageResources(MessageResourcesFactory factory,
                        java.lang.String config)

指定されたパラメータで新規 MessageResources を生成します。

パラメータ:

factory - 自身を生成する MessageResourcesFactory

config - MessageResources の設定パラメータ

MessageResources

public MessageResources(MessageResourcesFactory factory,
                        java.lang.String config,
                        boolean returnNull)

指定されたパラメータで新規 MessageResources を生成します。

パラメータ:

factory - 自身を生成する MessageResourcesFactory

config - MessageResources の設定パラメータ

returnNull - returnNull プロパティの初期値

メソッドの詳細

getConfig

public java.lang.String getConfig()

getFactory

public MessageResourcesFactory getFactory()

getReturnNull

public boolean getReturnNull()

setReturnNull

public void setReturnNull(boolean returnNull)

getMessage

public java.lang.String getMessage(java.lang.String key)

指定されたキーに該当するデフォルトLocaleでのテキストメッセージを返します。

パラメータ:

key - 参照するメッセージキー

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] args)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。

パラメータ:

key - 参照するメッセージキー

args - プレースホルダを置換するパラメータの配列

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object arg0)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。

パラメータ:

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object arg0,
                                   java.lang.Object arg1)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。

パラメータ:

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

arg1 - メッセージ内のプレースホルダ {1} に対する置換値

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object arg0,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。

パラメータ:

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

arg1 - メッセージ内のプレースホルダ {1} に対する置換値

arg2 - メッセージ内のプレースホルダ {2} に対する置換値

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object arg0,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2,
                                   java.lang.Object arg3)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。

パラメータ:

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

arg1 - メッセージ内のプレースホルダ {1} に対する置換値

arg2 - メッセージ内のプレースホルダ {2} に対する置換値

arg3 - メッセージ内のプレースホルダ {3} に対する置換値

getMessage

public abstract java.lang.String getMessage(java.util.Locale locale,
                                            java.lang.String key)

指定されたキーとLocaleに該当するテキストメッセージを返します。 もしこのメソッドにて、指定されたキーまたは Localeに対応するメッセージが見つからなかった場合、 returnNull プロパティがセットされている場合には null の文字列が返され、 その他の場合には適当なエラーメッセージが返されます。

このメソッドは具象サブクラスにて実装されなくてはなりません。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

getMessage

public java.lang.String getMessage(java.util.Locale locale,
                                   java.lang.String key,
                                   java.lang.Object[] args)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。 該当するリソースバンドルが設定されていない場合、null の文字列を返します。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

args - プレースホルダを置換するパラメータの配列

getMessage

public java.lang.String getMessage(java.util.Locale locale,
                                   java.lang.String key,
                                   java.lang.Object arg0)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。 このメソッドから null の文字列が返されることはありません。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

getMessage

public java.lang.String getMessage(java.util.Locale locale,
                                   java.lang.String key,
                                   java.lang.Object arg0,
                                   java.lang.Object arg1)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。 このメソッドから null の文字列が返されることはありません。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

arg1 - メッセージ内のプレースホルダ {1} に対する置換値

getMessage

public java.lang.String getMessage(java.util.Locale locale,
                                   java.lang.String key,
                                   java.lang.Object arg0,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。 このメソッドから null の文字列が返されることはありません。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

arg1 - メッセージ内のプレースホルダ {1} に対する置換値

arg2 - メッセージ内のプレースホルダ {2} に対する置換値

getMessage

public java.lang.String getMessage(java.util.Locale locale,
                                   java.lang.String key,
                                   java.lang.Object arg0,
                                   java.lang.Object arg1,
                                   java.lang.Object arg2,
                                   java.lang.Object arg3)

指定されたパラメータでプレースホルダの置換を行ない、生成したテキストメッセージを返します。 このメソッドから null の文字列が返されることはありません。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

arg0 - メッセージ内のプレースホルダ {0} に対する置換値

arg1 - メッセージ内のプレースホルダ {1} に対する置換値

arg2 - メッセージ内のプレースホルダ {2} に対する置換値

arg3 - メッセージ内のプレースホルダ {3} に対する置換値

isPresent

public boolean isPresent(java.lang.String key)

システムのデフォルトロケールで、指定されたキーに対応するメッセージが定義されている場合に true を返します。

パラメータ:

key - 参照するメッセージキー

isPresent

public boolean isPresent(java.util.Locale locale,
                         java.lang.String key)

指定されたLocaleとキーに対応するメッセージが定義されている場合に true を返します。

パラメータ:

locale - リクエストされたメッセージのLocale、 システムのデフォルトロケールを使用する場合には null

key - 参照するメッセージキー

escape

protected java.lang.String escape(java.lang.String string)

指定されたメッセージ文字列に含まれるシングルクオート文字のエスケープ処理を行います。

localeKey

protected java.lang.String localeKey(java.util.Locale locale)

Localeに対応するキャッシュ情報を参照するためのキーを計算し、返します。 注 - この実装でのデフォルト Locale に対応するロケールキーは 長さが0のStringです。

パラメータ:

locale - キーを要求されるLocale

messageKey

protected java.lang.String messageKey(java.util.Locale locale,
                                      java.lang.String key)

Localeとメッセージキーに対応するキャッシュ情報を参照するためのキーを計算し、返します。

パラメータ:

locale - キーを要求されるLocale

key - フォーマットキーを作成するためのメッセージキー

messageKey

protected java.lang.String messageKey(java.lang.String localeKey,
                                      java.lang.String key)

Localeキーとメッセージキーに対応するキャッシュ情報を参照するためのキーを計算し、返します。

パラメータ:

localeKey - キャッシュキーを作成するためのロケールキー

key - フォーマットキーを作成するためのメッセージキー

getMessageResources

public static MessageResources getMessageResources(java.lang.String config)

デフォルトのMessageResourcesFactory を使用して MessageResources インスタンスを生成し、返します。

パラメータ:

config - メッセージバンドルの設定パラメーター

log

public void log(java.lang.String message)

現在の環境に設定されている Writer に対して、メッセージをログ出力します。

パラメータ:

message - ログ出力するメッセージ

log

public void log(java.lang.String message,
                java.lang.Throwable throwable)

現在の環境に設定されている Writer に対して、メッセージと例外をログ出力します。

パラメータ:

message - ログ出力するメッセージ

throwable - ログ出力する例外