jp.littlesoft.util.res
クラス ResourceString

java.lang.Object
  jp.littlesoft.util.res.ResourceString

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

Serializable

直系の既知のサブクラス:

MessageResource

public class ResourceString
extends Object
implements Serializable

リソースから文字列の取得を行うためのクラス。

バージョン:

1.3.0

作成者:

LittleSoft Corporation

関連項目:

直列化された形式

コンストラクタの概要

ResourceString()
コンストラクタ。

ResourceString(String resourceClassField)
コンストラクタ。

ResourceString(String resourceClassName, String resourceFieldName)
コンストラクタ。

メソッドの概要

String	getResourceClassField() リソースのクラス名とフィールド名を取得します。
String	getResourceClassName() リソースのクラス名を取得します。
String	getResourceFieldName() リソースのフィールド名を取得します。
String	getValue() JVMのロケールを適用して、リソースの値を取得します。
String	getValue(Locale locale) リソースの値を取得します。
static String	getValue(String resourceClassName, String resourceFieldName, Locale locale) リソースクラス名とフィールド名とロケールを指定して、リソースの値を取得します。
static String	getValue(String resourceClassName, String resourceFieldName, Locale locale, ClassLoader loader) リソースの値を取得します。
static void	removeCustomMessage(String key) 各アプリケーション用のカスタムメッセージを削除します。
static void	setCustomMessage(String key, String message) 各アプリケーション用のカスタムメッセージを設定します。
void	setResourceClassField(String resourceClassField) リソースのクラス名とフィールド名を設定します。
void	setResourceClassName(String resourceClassName) リソースのクラス名を設定します。
void	setResourceFieldName(String resourceFieldName) リソースのフィールド名を設定します。

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

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

コンストラクタの詳細

ResourceString

public ResourceString()

コンストラクタ。

ResourceString

public ResourceString(String resourceClassField)

コンストラクタ。

パラメータ:

resourceClassField - リソースクラス名とフィールド名(ex. "jp.littlesoft.util.Msg.INVALID_DATAFIELD_NAME")

ResourceString

public ResourceString(String resourceClassName,
                      String resourceFieldName)

コンストラクタ。

パラメータ:

resourceClassName - リソースクラス名(ex. "jp.littlesoft.util.Msg")

resourceFieldName - リソースフィールド名(ex."INVALID_DATAFIELD_NAME")

メソッドの詳細

getResourceClassField

public String getResourceClassField()

リソースのクラス名とフィールド名を取得します。

戻り値:

リソースのクラス名とフィールド名(ex. "jp.littlesoft.util.Msg.INVALID_DATAFIELD_NAME")

setResourceClassField

public void setResourceClassField(String resourceClassField)

リソースのクラス名とフィールド名を設定します。

パラメータ:

resourceClassField - リソースクラス名とフィールド名(ex. "jp.littlesoft.util.Msg.INVALID_DATAFIELD_NAME")

setResourceClassName

public void setResourceClassName(String resourceClassName)

リソースのクラス名を設定します。

パラメータ:

resourceClassName - リソースクラス名(ex. "jp.littlesoft.util.Msg")

getResourceClassName

public String getResourceClassName()

リソースのクラス名を取得します。

戻り値:

リソースクラス名(ex. "jp.littlesoft.util.Msg")

setResourceFieldName

public void setResourceFieldName(String resourceFieldName)

リソースのフィールド名を設定します。

パラメータ:

resourceFieldName - リソースフィールド名(ex."INVALID_DATAFIELD_NAME")

getResourceFieldName

public String getResourceFieldName()

リソースのフィールド名を取得します。

戻り値:

リソースフィールド名(ex."INVALID_DATAFIELD_NAME")

getValue

public String getValue()
                throws DataException

JVMのロケールを適用して、リソースの値を取得します。

リソースファイルからの読み込みを試みます。
リソースファイルに未定義の場合は、Javaクラスから値を取得します。
ロケールにはJVMのロケールが適用されます。

戻り値:

リソースの値

例外:

DataException

getValue

public String getValue(Locale locale)
                throws DataException

リソースの値を取得します。

リソースファイルからの読み込みを試みます。
リソースファイルに未定義の場合は、Javaクラスから値を取得します。

パラメータ:

locale - ロケール(nullの場合は、JVMのロケールが適用されます)

戻り値:

リソースの値

例外:

DataException

getValue

public static String getValue(String resourceClassName,
                              String resourceFieldName,
                              Locale locale)
                       throws DataException

リソースクラス名とフィールド名とロケールを指定して、リソースの値を取得します。

パラメータ:

resourceClassName - リソースクラス名(ex. "jp.littlesoft.util.Msg")

resourceFieldName - リソースフィールド名(ex."INVALID_DATAFIELD_NAME")

locale - ロケール(nullの場合は、JVMのロケールが適用されます。)

戻り値:

リソースの値

例外:

DataException

getValue

public static String getValue(String resourceClassName,
                              String resourceFieldName,
                              Locale locale,
                              ClassLoader loader)
                       throws DataException

リソースの値を取得します。

リソースファイルからの読み込みを試みます。
リソースファイルに未定義の場合は、Javaクラスから値を取得します。

リソースの値の取得には、java.util.ResouceBundle.getBundle()メソッドを利用しています。
指定したロケールでリソースファイルが見つからなかった場合は、 デフォルトのロケール(Locale.getDefault())のリソースファイルを見つけようとします。
それでも見つからない場合は、ロケールなしのリソースファイルを見つけようとします。
それでも見つからない場合は、Javaクラスのstaticフィールドを返します。
staticフィールドが見つからない場合は、DataExceptionをスローします。

パラメータ:

resourceClassName - リソースの基底名 (例:"jp.littlesoft.util.Msg")

resourceFieldName - リソースのフィールド名 (例:"INVALID_DATAFIELD_NAME")

locale - ロケール(デフォルトのロケールを利用する場合はnull)

loader - クラスローダー(デフォルトのクラスローダーを利用する場合はnull)

戻り値:

リソースの値

例外:

DataException

setCustomMessage

public static void setCustomMessage(String key,
                                    String message)

各アプリケーション用のカスタムメッセージを設定します。

パラメータ:

key - キー

message - メッセージ

removeCustomMessage

public static void removeCustomMessage(String key)

各アプリケーション用のカスタムメッセージを削除します。

パラメータ:

key - キー