com.github.mygreen.supercsv.localization

クラス ResourceBundleMessageResolver

java.lang.Object

com.github.mygreen.supercsv.localization.ResourceBundleMessageResolver

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

MessageResolver

public class ResourceBundleMessageResolver
extends Object
implements MessageResolver

ResourceBundleを元にメッセージを解決するクラス。

クラスパスのルートにリソース名がSuperCsvMessagesのプロパティファイルを配置していると自動的に読み込みます。

デフォルトでは、DEFAULT_MESSAGEに配置されているリソースファイルを読み込みます。

バージョン:

2.2

作成者:

T.TSUCHIE

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	DEFAULT_MESSAGE デフォルトのメッセージソースのぱす

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

コンストラクタ

コンストラクタと説明
ResourceBundleMessageResolver() デフォルトのコンストラクタ。
ResourceBundleMessageResolver(ResourceBundle resourceBundle) 独自のメッセージソースを指定してインスタンスを作成する。
ResourceBundleMessageResolver(String baseName, boolean appendUserResource) メッセージリソースのパスを指定して、インスタンスを作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	addResourceBundle(ResourceBundle resourceBundle) メッセージソースを追加します。
Optional<String>	getMessage(String code) コードを指定してメッセージを取得する。
boolean	removeResourceBundle(ResourceBundle resourceBundle) メッセージソースを削除する。

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

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

フィールドの詳細

DEFAULT_MESSAGE

public static final String DEFAULT_MESSAGE

デフォルトのメッセージソースのぱす

関連項目:

定数フィールド値

コンストラクタの詳細

ResourceBundleMessageResolver

public ResourceBundleMessageResolver(String baseName,
                                     boolean appendUserResource)

メッセージリソースのパスを指定して、インスタンスを作成します。

パラメータ:

baseName - メッセージリソースのパス。

appendUserResource - クラスパスのルートにあるユーザ定義のメッセージソースも読み込むかどうか指定します。 引数baseNameの値が sample.SampleMessagesのとき、クラスパスのルート上にある「SampleMessages」を読み込みます。

例外:

NullPointerException - baseName is null.

IllegalArgumentException - baseName is empty.

ResourceBundleMessageResolver

public ResourceBundleMessageResolver()

デフォルトのコンストラクタ。

デフォルトのメッセージソースDEFAULT_MESSAGEが自動的に読み込まれます。

ResourceBundleMessageResolver

public ResourceBundleMessageResolver(ResourceBundle resourceBundle)

独自のメッセージソースを指定してインスタンスを作成する。

デフォルトのメッセージソースDEFAULT_MESSAGEが自動的に読み込まれます。

パラメータ:

resourceBundle - 独自のメッセージメース

例外:

NullPointerException - resourceBundle is null.

メソッドの詳細

getMessage

public Optional<String> getMessage(String code)

コードを指定してメッセージを取得する。

定義:

getMessage インタフェース内 MessageResolver

パラメータ:

code - メッセージのコード。

戻り値:

指定したコードが見つからない場合は、空を返す。

addResourceBundle

public final boolean addResourceBundle(ResourceBundle resourceBundle)

メッセージソースを追加します。

パラメータ:

resourceBundle - 追加するメッセージソース。

戻り値:

既に追加済みの場合はfalseを返します。

例外:

NullPointerException - resourceBundle is null.

removeResourceBundle

public boolean removeResourceBundle(ResourceBundle resourceBundle)

メッセージソースを削除する。

パラメータ:

resourceBundle - 削除対象のメッセージソース

戻り値:

登録されているメッセージソースがある場合はtrueを返します。

例外:

NullPointerException - resourceBundle is null.