nablarch.core.message

クラス MessageUtil

java.lang.Object

nablarch.core.message.MessageUtil

@Published
public final class MessageUtil
extends Object

アプリケーションがメッセージを取得する際に使用するユーティリティクラス。

SystemRepositoryからStringResourceHolderを取得する。 取得できなかった場合は、PropertiesStringResourceLoaderでロードしたリソースキャッシュを持つStringResourceHolderを取得する。

作成者:

Koichi Asano

関連項目:

SystemRepository, PropertiesStringResourceLoader, StringResourceHolder

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static Message	createMessage(MessageLevel level, String messageId, Object... options) メッセージを生成する。
static StringResource	getStringResource(String messageId) メッセージIDに対応するStringResourceを取得する。

メソッドの詳細

createMessage

public static Message createMessage(MessageLevel level,
                                    String messageId,
                                    Object... options)

メッセージを生成する。 テンプレート文字列が以下であるときの例を示す。
「errors.maxLength={0}は{1}文字以下で入力してください。」
例:

 
 Message message = MessageUtil.createMessage(MessageLevel.ERROR, "errors.maxLength", "sample", 2);
 String str = message.formatMessage(); //--> sampleは2文字以下で入力してください。
 

パラメータ:

level - メッセージレベル

messageId - メッセージID

options - メッセージフォーマットに使用するオプション引数

戻り値:

生成したMessage

関連項目:

MessageLevel, Message

getStringResource

public static StringResource getStringResource(String messageId)

メッセージIDに対応するStringResourceを取得する。 メッセージIDがnullである場合は、nullを返す。

テンプレート文字列が以下であるときの例を示す。
「errors.maxLength={0}は{1}文字以下で入力してください。」
例:

 
 StringResource resource = MessageUtil.getStringResource("errors.maxLength"); //-->メッセージIDに対応する文字列リソースを取得。
 

パラメータ:

messageId - メッセージID

戻り値:

取得したメッセージ