jp.co.intra_mart.framework.base.message

クラス TextFileMessagePropertyHandler

java.lang.Object

jp.co.intra_mart.framework.base.message.TextFileMessagePropertyHandler

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

MessagePropertyHandler, PropertyHandler

public class TextFileMessagePropertyHandler
extends Object
implements MessagePropertyHandler

指定されたファイルからプロパティ情報を取得するメッセージプロパティハンドラです。 ファイルの書式はDefaultMessagePropertyHandlerで示されるものと同じです。
ファイルが存在するディレクトリ名はPARAM_FILE_DIRで示されるパラメータ名で指定します。
PARAM_DYNAMICで示されるパラメータにtrueを指定した場合 アプリケーション実行時にもプロパティの変更を動的に反映させることが可能となりますが、 パラメータの取得時に毎回ファイル操作を行うためパフォーマンスに悪影響を与える可能性があります。 このオプションは、開発時やデバッグ時のようにパラメータを頻繁に変更する必要がある場合のみtrueとし、 通常はfalseに設定しておいてください。

導入されたバージョン:

4.2

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	PARAM_DYNAMIC プロパティファイルの再読み込み可能のパラメータ名
static String	PARAM_FILE_DIR プロパティファイルのファイルパスのパラメータ名

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

コンストラクタ

コンストラクタと説明
TextFileMessagePropertyHandler()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getMessage(String application, String key) メッセージを取得します。
String	getMessage(String application, String key, Locale locale) メッセージを取得します。
void	init(PropertyParam[] params) プロパティハンドラを初期化します。
boolean	isDynamic() プロパティの動的読み込みが可能かどうか調べます。

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

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

フィールドの詳細

PARAM_FILE_DIR

public static final String PARAM_FILE_DIR

プロパティファイルのファイルパスのパラメータ名

関連項目:

定数フィールド値

PARAM_DYNAMIC

public static final String PARAM_DYNAMIC

プロパティファイルの再読み込み可能のパラメータ名

関連項目:

定数フィールド値

コンストラクタの詳細

TextFileMessagePropertyHandler

public TextFileMessagePropertyHandler()

メソッドの詳細

isDynamic

public boolean isDynamic()
                  throws MessagePropertyException

プロパティの動的読み込みが可能かどうか調べます。

定義:

isDynamic インタフェース内 MessagePropertyHandler

戻り値:

true 再設定可能、false 再設定不可

例外:

MessagePropertyException - チェック時に例外が発生

getMessage

public String getMessage(String application,
                         String key)
                  throws MessagePropertyException

メッセージを取得します。 applicationで指定されるアプリケーション固有のプロパティから keyに該当するメッセージを取得します。 システムが稼動しているロケールをヒントにメッセージを取得します。

定義:

getMessage インタフェース内 MessagePropertyHandler

パラメータ:

application - アプリケーションID

key - メッセージのキー

戻り値:

メッセージ

例外:

MessagePropertyException - メッセージ取得時に例外が発生

getMessage

public String getMessage(String application,
                         String key,
                         Locale locale)
                  throws MessagePropertyException

メッセージを取得します。 applicationで指定されるアプリケーション固有のプロパティから keyに該当するメッセージを取得します。 locale で指定されたロケールをヒントにメッセージを取得します。

定義:

getMessage インタフェース内 MessagePropertyHandler

パラメータ:

application - アプリケーションID

key - メッセージのキー

locale - ロケール

戻り値:

メッセージ

例外:

MessagePropertyException - メッセージ取得時に例外が発生

init

public void init(PropertyParam[] params)
          throws PropertyHandlerException

プロパティハンドラを初期化します。

定義:

init インタフェース内 PropertyHandler

パラメータ:

params - 初期パラメータ

例外:

PropertyHandlerException - プロパティハンドラの初期化時に例外が発生