org.seasar.aptina.commons.message
クラス EnumMessageFormatter<T extends Enum<T> & EnumMessageCode>

java.lang.Object
  上位を拡張 org.seasar.aptina.commons.message.EnumMessageFormatter<T>
型パラメータ:
T - パターンを定義した列挙の型

public class EnumMessageFormatter<T extends Enum<T> & EnumMessageCode>
extends Object

列挙に定義された Formatter のパターンを使用してメッセージを組み立てるクラスです.

MessageFormat のパターンを使用する場合は EnumMessageTextFormatter を使用してください.

パターンを定義した列挙は EnumMessageCode を実装していなければなりません.

コンストラクタ引数で Appendable を渡した場合は format(Enum, Object...) を呼び出すことで組み立てられたメッセージが出力先に追加されます. 追加された文字列は toString() を呼び出すことで取得することができます.

作成者:
koichik

フィールドの概要
protected  ResourceBundle bundle
          リソースバンドル
protected  Formatter formatter
          フォーマッタ
 
コンストラクタの概要
EnumMessageFormatter(Class<T> enumClass)
          デフォルトロケールでインスタンスを構築します.
EnumMessageFormatter(Class<T> enumClass, Appendable out)
          デフォルトロケールでインスタンスを構築します.
EnumMessageFormatter(Class<T> enumClass, Appendable out, Locale locale)
          ロケールを指定してインスタンスを構築します.
EnumMessageFormatter(Class<T> enumClass, Locale locale)
          ロケールを指定してインスタンスを構築します.
 
メソッドの概要
 EnumMessageFormatter<T> format(T messageCode, Object... args)
          列挙に定義されたパターンを使用して作成したメッセージを出力先に追加します.
 String getMessage(T messageCode, Object... args)
          列挙に定義されたパターンを使用してメッセージを作成して返します.
 String getPattern(T messageCode)
          列挙に定義されたパターンを返します.
 String toString()
          出力先に追加された文字列を返します.
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

bundle

protected final ResourceBundle bundle
リソースバンドル


formatter

protected final Formatter formatter
フォーマッタ

コンストラクタの詳細

EnumMessageFormatter

public EnumMessageFormatter(Class<T> enumClass)
デフォルトロケールでインスタンスを構築します.

パラメータ:
enumClass - パターンを定義した列挙の型

EnumMessageFormatter

public EnumMessageFormatter(Class<T> enumClass,
                            Appendable out)
デフォルトロケールでインスタンスを構築します.

パラメータ:
enumClass - パターンを定義した列挙の型
out - 出力先

EnumMessageFormatter

public EnumMessageFormatter(Class<T> enumClass,
                            Locale locale)
ロケールを指定してインスタンスを構築します.

パラメータ:
enumClass - パターンを定義した列挙の型
locale - ロケール

EnumMessageFormatter

public EnumMessageFormatter(Class<T> enumClass,
                            Appendable out,
                            Locale locale)
ロケールを指定してインスタンスを構築します.

パラメータ:
enumClass - パターンを定義した列挙の型
out - 出力先
locale - ロケール
メソッドの詳細

getPattern

public String getPattern(T messageCode)
列挙に定義されたパターンを返します.

パラメータ:
messageCode - 列挙
戻り値:
列挙に定義されたパターン

getMessage

public String getMessage(T messageCode,
                         Object... args)
列挙に定義されたパターンを使用してメッセージを作成して返します.

パラメータ:
messageCode - 列挙
args - 引数
戻り値:
列挙に定義されたパターンを使用して作成したメッセージ

format

public EnumMessageFormatter<T> format(T messageCode,
                                      Object... args)
列挙に定義されたパターンを使用して作成したメッセージを出力先に追加します.

パラメータ:
messageCode - 列挙
args - 引数
戻り値:
このインスタンス自身

toString

public String toString()
出力先に追加された文字列を返します.

オーバーライド:
クラス Object 内の toString
戻り値:
追加された文字列


Copyright © 2009-2010 The Seasar Foundation. All Rights Reserved.