com.github.mygreen.supercsv.localization

クラス MessageBuilder

java.lang.Object

com.github.mygreen.supercsv.localization.MessageBuilder

public class MessageBuilder
extends Object

エラーメッセージを組み立てたりするためのユーティリティクラス。

導入されたバージョン:

2.0

作成者:

T.TSUCHIE

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

コンストラクタ

コンストラクタと説明
MessageBuilder(String code) メッセージコードを指定してインスタンスを作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static MessageBuilder	create(String code) メッセージの組み立てを開始します。
String	format() メッセージをフォーマットして値を取得します。
String	format(boolean recusrsive) メッセージをフォーマットして値を取得します。
MessageBuilder	var(String key, Object value) メッセージ変数を追加する。
MessageBuilder	varWithAnno(String key, Class<? extends Annotation> annoClass) メッセージ変数としてアノテーション名を追加する。
MessageBuilder	varWithClass(String key, Class<?> clazz) メッセージ変数として、クラス名を追加する。

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

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

コンストラクタの詳細

MessageBuilder

public MessageBuilder(String code)

メッセージコードを指定してインスタンスを作成します。

パラメータ:

code - メッセージコード

例外:

NullPointerException - code is null.

IllegalArgumentException - code is empty.

メソッドの詳細

var

public MessageBuilder var(String key,
                          Object value)

メッセージ変数を追加する。

パラメータ:

key - 変数名

value - 値

戻り値:

自身のインスタンス

varWithAnno

public MessageBuilder varWithAnno(String key,
                                  Class<? extends Annotation> annoClass)

メッセージ変数としてアノテーション名を追加する。

パラメータ:

key - 変数名

annoClass - アノテーションのクラス名

戻り値:

自身のインスタンス

varWithClass

public MessageBuilder varWithClass(String key,
                                   Class<?> clazz)

メッセージ変数として、クラス名を追加する。

クラス名は、FQCNの形式

パラメータ:

key - 変数名

clazz - クラスタイプ

戻り値:

自身のインスタンス

format

public String format()

メッセージをフォーマットして値を取得します。

変換したメッセージに対しても再帰的に処理しません。

戻り値:

フォーマットしたメッセージ

例外:

IllegalArgumentException - 指定したメッセージコードが見つからない場合

format

public String format(boolean recusrsive)

メッセージをフォーマットして値を取得します。

パラメータ:

recusrsive - 変換したメッセージに対しても再帰的に処理するかどうか。

戻り値:

フォーマットしたメッセージ

例外:

IllegalArgumentException - 指定したメッセージコードが見つからない場合

create

public static MessageBuilder create(String code)

メッセージの組み立てを開始します。

パラメータ:

code - メッセージコード。

戻り値:

メッセージを組み立てるためのクラス。