|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||
java.lang.Objectjp.terasoluna.fw.message.MessageManager
public class MessageManager
メッセージ管理クラス
| フィールドの概要 | |
|---|---|
protected List<String> |
basenames
メッセージプロパティファイルのベースネームリスト |
protected static String |
DEFAULT_MESSAGE_BASE_NAME_KEY
メッセージプロパティファイルベースネームのキーのデフォルト値 |
protected static String |
DEFAULT_MESSAGE_FORMATTER_FQCN_KEY
メッセージフォーマッタのFQCNを指定するキーのデフォルト値 |
protected static String |
DEFAULT_MESSAGE_ID_FORMAT_KEY
メッセージIDのフォーマットのキーのデフォルト値 |
protected static String |
DEFAULT_THROW_IF_RESOURCE_NOT_FOUND_KEY
メッセージIDが見つからなかった場合に例外をスローするか否かのキーのデフォルト値 |
protected MessageFormatter |
messageFormatter
メッセージフォーマッタ |
protected String |
messageIdFormat
メッセージIDのフォーマット |
protected boolean |
throwIfResourceNotFound
メッセージIDが見つからなかった場合に例外をスローするか否か |
| コンストラクタの概要 | |
|---|---|
MessageManager(String configFile)
コンストラクタ メッセージIDのフォーマットのキー、メッセージプロパティファイルベースネームのキー、 メッセージIDが見つからなかった場合に例外をスローするか否かのキー、メッセージフォーマッタのFQCNを指定するキーはデフォルト値を設定し、 MessageManager(String, String, String, String, String)
を呼び出します。 |
|
MessageManager(String configFile,
String messageIdFormatKey,
String messageBaseNameKey,
String throwIfResourceNotFoundKey,
String messageFormatterFqcnKey)
コンストラクタ クラスローダからプロパティファイルを取得し、新しいメッセージマネージャーを構築します。 |
|
| メソッドの概要 | |
|---|---|
protected static ClassLoader |
getClassLoader()
クラスローダを返却します。 |
String |
getMessage(boolean resource,
String messageIdOrPattern,
Locale locale,
Object... args)
メッセージを返却します。 |
String |
getMessage(boolean resource,
String messageIdOrPattern,
Object... args)
メッセージを返却します。 |
protected String |
getMessagePattern(String messageId,
Locale locale)
メッセージパターンを返却します。 |
protected ResourceBundle |
getResourceBundle(String basename,
Locale locale)
メッセージプロパティファイル内のベースネームに対応したリソースバンドルを返却します。 |
protected String |
getStringOrNull(ResourceBundle bundle,
String key)
プロパティファイルに存在する、メッセージIDに対応したメッセージを返却します。 |
| クラス java.lang.Object から継承されたメソッド |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| フィールドの詳細 |
|---|
protected final List<String> basenames
protected String messageIdFormat
protected boolean throwIfResourceNotFound
protected final MessageFormatter messageFormatter
protected static final String DEFAULT_MESSAGE_ID_FORMAT_KEY
protected static final String DEFAULT_MESSAGE_BASE_NAME_KEY
protected static final String DEFAULT_THROW_IF_RESOURCE_NOT_FOUND_KEY
protected static final String DEFAULT_MESSAGE_FORMATTER_FQCN_KEY
| コンストラクタの詳細 |
|---|
public MessageManager(String configFile)
メッセージIDのフォーマットのキー、メッセージプロパティファイルベースネームのキー、 メッセージIDが見つからなかった場合に例外をスローするか否かのキー、メッセージフォーマッタのFQCNを指定するキーはデフォルト値を設定し、 MessageManager(String, String, String, String, String)
を呼び出します。
configFile - 設定ファイルパス(クラスローダ相対)MessageManager#MessageManager(String, String, String, String)
public MessageManager(String configFile,
String messageIdFormatKey,
String messageBaseNameKey,
String throwIfResourceNotFoundKey,
String messageFormatterFqcnKey)
引数で取得した設定ファイルパスに該当するプロパティファイルを取得します。
プロパティファイル取得の際は以下の項目を合わせて設定します。
(設定値がない場合は、デフォルト値を使用します。)
・メッセージIDのフォーマットのキー
・メッセージプロパティファイルのベースネームのキー
・メッセージID不明時の例外スロー有無
・メッセージフォーマッタのFQCN
プロパティファイルから得たメッセージIDのフォーマット、例外スローフラグはメンバ変数に格納します。
メッセージベースネームはクラスローダから取得できるものを全て追加し、文字列のリストのメンバ変数に格納します。
configFile - 設定ファイルパス(クラスローダ相対)messageIdFormatKey - メッセージIDのフォーマットのキーmessageBaseNameKey - メッセージプロパティファイルベースネームのキーthrowIfResourceNotFoundKey - メッセージIDが見つからなかった場合に例外をスローするか否かのキーmessageFormatterFqcnKey - メッセージフォーマッタのFQCNを指定するキー| メソッドの詳細 |
|---|
protected static ClassLoader getClassLoader()
呼び出されたスレッドにコンテキスト・クラスローダが設定されている場合はそのコンテキスト・クラスローダを返却します。
そうでない場合はこのクラスをロードしたクラスローダを返却します。
protected ResourceBundle getResourceBundle(String basename,
Locale locale)
MessageRuntimeExceptionをスローします。 例外スローフラグが負の場合は、null値を設定したリソースバンドルを返却します。
basename - メッセージプロパティファイルのベースネームlocale - ロケール
protected String getStringOrNull(ResourceBundle bundle,
String key)
bundleがfalseの場合keyがfalseの場合
引数のリソースバンドルに対して、引数のメッセージIDに対応するメッセージを取得します。 メッセージIDに対応するメッセージが存在しない場合は、例外スローフラグが正の場合に限り、取得できなかったメッセージID名を文字出力します。 メッセージID名の文字出力と同時にMessageRuntimeExceptionをスローします。
例外スローフラグが負の場合は、null値を返却します。
bundle - リソースバンドルkey - メッセージID
protected String getMessagePattern(String messageId,
Locale locale)
messageId - メッセージIDlocale - メッセージのロケール
public String getMessage(boolean resource,
String messageIdOrPattern,
Object... args)
throws MessageRuntimeException
getMessage(boolean, String, Locale, Object...) を呼び出します。 ロケールにはデフォルト値が使用されます。
resource - リソースの有無messageIdOrPattern - メッセージID(リソース有の場合) / メッセージパターン(リソース無の場合)args - 置換パラメータ
MessageRuntimeException - 不正なパターンを指定した場合
public String getMessage(boolean resource,
String messageIdOrPattern,
Locale locale,
Object... args)
throws MessageRuntimeException
resourceがtrueの場合MessageFormat の形式にしてください。不正なパターンを指定した場合、MessageRuntimeExceptionをスローしますLocale.getDefault()が使用されます。resourceがfalseの場合messageIdOrPattern)に置換パラメータを埋め込んだメッセージを返却します。パターンは MessageFormatの形式にしてください。不正なパターンを指定した場合、 MessageRuntimeExceptionをスローします。
resource - リソースの有無messageIdOrPattern - メッセージID(リソース有の場合) / メッセージパターン(リソース無の場合)locale - ロケールargs - 置換パラメータ
MessageRuntimeException - 不正なパターンを指定した場合
|
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | |||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | |||||||||