public abstract class ResourceBundle extends Object
String
などのロケール固有のリソースが必要なときは、現在のユーザーのロケールに合ったリソースバンドルからロードできます。このように、リソースバンドルから、ロケール固有の情報のすべてでなくてもその大部分を切り離すことで、ユーザーのロケールにはほとんど依存しないプログラムコードを書くことができます。
これにより、以下の特徴を持つプログラムを書くことが可能になります。
リソースバンドルはファミリに属しています。そのファミリでは、メンバーは共通の基底名を共有していますが、ファミリ名にはロケールを識別する追加コンポーネントも含まれています。たとえば、リソースバンドルのファミリの基底名は「MyResources」です。ファミリは、ファミリと同じ名前 (MyResources) で、特定のロケールがサポートされない場合は、最後の手段のバンドルとして使用される、デフォルトのリソースバントルを持つ必要があります。また、ファミリは、必要なだけの数のロケール固有のメンバーを提供することができます。たとえば、「MyResources_de」と名付けられたドイツのメンバーなどです。
ファミリの各リソースバンドルには同じ項目がありますが、こうした項目は当該リソースバンドルにより表されるロケールに合わせて翻訳されています。たとえば、「MyResources」と「MyResources_de」の両方に、操作を取り消すためのボタンで使用される String
があるとします。その String
に、「MyResources」では「Cancel」を格納し、「MyResources_de」では「Abbrechen」を格納することができます。
同じ言語を使用するロケールでも国によってリソースが異なるときは、特殊化が可能です。たとえば、「MyResources_de_CH」には、スイス (CH) 系のドイツ語 (de) のオブジェクトが含まれています。リソースの一部だけを修正することもできます。
プログラムでロケール固有のオブジェクトが必要なときは、getBundle
メソッドを使用して ResourceBundle
クラスをロードします。
ResourceBundle myResources = ResourceBundle.getBundle("MyResources", currentLocale);
リソースバンドルは、キーと値のペアになっています。キーは、バンドルのロケール固有のオブジェクトを一意に識別します。キーと値の 2 つのペアが含まれている ListResourceBundle
の例を示します。
キーは常にpublic class MyResources extends ListResourceBundle { protected Object[][] getContents() { return new Object[][] { // LOCALIZE THE SECOND STRING OF EACH ARRAY (e.g., "OK") {"OkKey", "OK"}, {"CancelKey", "Cancel"}, // END OF MATERIAL TO LOCALIZE }; } }
String
です。この例では、キーは「OkKey」と「CancelKey」です。前述した例では、値「OK」と「Cancel」も String
ですが、必ずしもそうである必要はありません。値は、どの型のオブジェクトでも可能です。
リソースバンドルから適切な getter メソッドを使用してオブジェクトを検索します。「OkKey」と「CancelKey」はどちらも文字列なので、取得には getString
を使用します。
getter メソッドは、すべて引数としてキーを要求し、検出したオブジェクトを返します。オブジェクトが見つからない場合、getter メソッドはbutton1 = new Button(myResources.getString("OkKey")); button2 = new Button(myResources.getString("CancelKey"));
MissingResourceException
をスローします。
getString
以外に、ResourceBundle
では、文字列配列を取得する getStringArray
メソッドも提供します。同様に、ほかの型のオブジェクトを取得するジェネリック getObject
メソッドも提供します。getObject
を使用する場合、結果を適切な型にキャストする必要があります。たとえば、
int[] myIntegers = (int[]) myResources.getObject("intList");
Java プラットフォームでは、ResourceBundle
の 2 つのサブクラス ListResourceBundle
および PropertyResourceBundle
が用意されています。これらはリソースを作成するかなり簡単な方法を提供します。前の例で簡単に示したように、ListResourceBundle
は、そのリソースをキーと値のペアのリストとして管理します。PropertyResourceBundle
は、プロパティーファイルを使用してそのリソースを管理します。
ListResourceBundle
または PropertyResourceBundle
では不十分なときは、独自の ResourceBundle
サブクラスを書くことができます。サブクラスでオーバーライドしなければいけないメソッドは 2 つあります。handleGetObject
および getKeys()
。
ResourceBundle.Control
クラスは、ResourceBundle.Control
インスタンスを取る getBundle
ファクトリメソッドがバンドルロード処理を実行する際に必要とする情報を提供します。ユーザー独自のサブクラスを実装すれば、標準以外のリソースバンドル形式を利用できるようにしたり、検索手順を変更したり、キャッシュパラメータを定義したりできます。詳細については、そのクラスと getBundle
ファクトリメソッドの説明を参照してください。
getBundle
ファクトリメソッドによって作成されたリソースバンドルインスタンスはデフォルトで、キャッシュに格納されます。ファクトリメソッドは、目的のリソースバンドルインスタンスがキャッシュに格納されていれば、その同じインスタンスを複数回返します。getBundle
クライアントは、キャッシュをクリアーしたり、有効期間の値を使ってキャッシュ内のリソースバンドルインスタンスの寿命を管理したり、リソースバンドルインスタンスをキャッシュしないように指定したりできます。詳細については、getBundle
ファクトリメソッド、clearCache
、ResourceBundle.Control.getTimeToLive
、および ResourceBundle.Control.needsReload
の説明を参照してください。
ResourceBundle
のサブクラス MyResources
の非常に簡単な例です。このサブクラスは 2 つのリソースを管理します (サブクラスが多数のリソースを管理する場合は、Map
を使用する)。「親レベル」の ResourceBundle
が、(下記の okKey のように) 同じ値を持つ同じキーを扱う場合は、値を提供する必要はありません。
// default (English language, United States) public class MyResources extends ResourceBundle { public Object handleGetObject(String key) { if (key.equals("okKey")) return "Ok"; if (key.equals("cancelKey")) return "Cancel"; return null; } public Enumeration<String> getKeys() { return Collections.enumeration(keySet()); } // Overrides handleKeySet() so that the getKeys() implementation // can rely on the keySet() value. protected Set<String> handleKeySet() { return new HashSet<String>(Arrays.asList("okKey", "cancelKey")); } } // German language public class MyResources_de extends MyResources { public Object handleGetObject(String key) { // don't need okKey, since parent level handles it. if (key.equals("cancelKey")) return "Abbrechen"; return null; } protected Set<String> handleKeySet() { return new HashSet<String>(Arrays.asList("cancelKey")); } }
ResourceBundle
の単一のファミリだけを使用する必要はありません。たとえば、例外メッセージ ExceptionResources
(ExceptionResources_fr
、ExceptionResources_de
など) で 1 つ、ウィジェット WidgetResource
(WidgetResources_fr
、WidgetResources_de
など) で 1 つというように、好きなようにリソースを分割してバンドルのセットを持つこともできます。ListResourceBundle
, PropertyResourceBundle
, MissingResourceException
修飾子と型 | クラスと説明 |
---|---|
static class |
ResourceBundle.Control
ResourceBundle.Control は、バンドルロード処理中に ResourceBundle.getBundle ファクトリによって呼び出される一連のコールバックメソッドを定義します。 |
修飾子と型 | フィールドと説明 |
---|---|
protected ResourceBundle |
parent
このバンドルの親バンドル。
|
コンストラクタと説明 |
---|
ResourceBundle()
唯一のコンストラクタです。
|
修飾子と型 | メソッドと説明 |
---|---|
static void |
clearCache()
呼び出し元のクラスローダーを使ってロードされたリソースバンドルのすべてを、キャッシュから削除します。
|
static void |
clearCache(ClassLoader loader)
指定されたクラスローダーを使ってロードされたリソースバンドルのすべてを、キャッシュから削除します。
|
boolean |
containsKey(String key)
指定された
key がこの ResourceBundle またはその親バンドル内に含まれるかどうかを判定します。 |
static ResourceBundle |
getBundle(String baseName)
指定された基底名、デフォルトのロケール、および呼び出し側のクラスローダーを使用して、リソースバンドルを取得します。
|
static ResourceBundle |
getBundle(String baseName, Locale locale)
指定された基底名、ロケール、および呼び出し側のクラスローダーを使用して、リソースバンドルを取得します。
|
static ResourceBundle |
getBundle(String baseName, Locale locale, ClassLoader loader)
指定された基底名、ロケール、クラスローダーを使用して、リソースバンドルを取得します。
|
static ResourceBundle |
getBundle(String baseName, Locale targetLocale, ClassLoader loader, ResourceBundle.Control control)
指定された基底名、ターゲットロケール、クラスローダー、およびコントロールを使用して、リソースバンドルを返します。
|
static ResourceBundle |
getBundle(String baseName, Locale targetLocale, ResourceBundle.Control control)
指定された基底名、ターゲットロケール、コントロール、および呼び出し側のクラスローダーを使用して、リソースバンドルを返します。
|
static ResourceBundle |
getBundle(String baseName, ResourceBundle.Control control)
指定された基底名、デフォルトのロケール、および指定されたコントロールに基づいて、リソースバンドルを返します。
|
abstract Enumeration<String> |
getKeys()
キーのリストを返します。
|
Locale |
getLocale()
リソースバンドルの Locale を返します。
|
Object |
getObject(String key)
このリソースバンドルまたはその親リソースバンドルのいずれかから指定されたキーのオブジェクトを取得します。
|
String |
getString(String key)
このリソースバンドルまたはその親リソースバンドルのいずれかから指定されたキーの文字列を取得します。
|
String[] |
getStringArray(String key)
このリソースバンドルまたはその親リソースバンドルのいずれかから指定されたキーの文字列配列を取得します。
|
protected abstract Object |
handleGetObject(String key)
このリソースバンドルから指定されたキーのオブジェクトを取得します。
|
protected Set<String> |
handleKeySet()
この
ResourceBundle にのみ含まれるキーの Set を返します。 |
Set<String> |
keySet()
この
ResourceBundle とその親バンドル内に含まれるすべてのキーの Set を返します。 |
protected void |
setParent(ResourceBundle parent)
このバンドルの親バンドルを設定します。
|
protected ResourceBundle parent
getObject
によって検索されます。public ResourceBundle()
public final String getString(String key)
(String) getObject
(key)
.
key
- 目的の文字列のキーNullPointerException
- key
が null
である場合MissingResourceException
- 指定されたキーのオブジェクトが見つからない場合ClassCastException
- 指定されたキーの見つかったオブジェクトが文字列でない場合public final String[] getStringArray(String key)
(String[]) getObject
(key)
.
key
- 目的の文字列配列のキーNullPointerException
- key
が null
である場合MissingResourceException
- 指定されたキーのオブジェクトが見つからない場合ClassCastException
- 指定されたキーの見つかったオブジェクトが文字列配列でない場合public final Object getObject(String key)
handleGetObject
を使用して、このリソースバンドルからオブジェクトを取得しようとします。失敗した場合、親リソースバンドルが null でないときは、親の getObject
メソッドを呼び出します。それでも取得できない場合は、MissingResourceException をスローします。key
- 目的のオブジェクトのキーNullPointerException
- key
が null
である場合MissingResourceException
- 指定されたキーのオブジェクトが見つからない場合public Locale getLocale()
protected void setParent(ResourceBundle parent)
getObject
によって検索されます。parent
- このバンドルの親バンドル。public static final ResourceBundle getBundle(String baseName)
getBundle(baseName, Locale.getDefault(), this.getClass().getClassLoader())
,
getClassLoader()
が、ResourceBundle
のセキュリティー特権により実行されることだけが異なります。検索とインスタンス化の方法の詳細は、getBundle
を参照してください。baseName
- リソースバンドルの基底名。完全指定クラス名NullPointerException
- baseName
が null
である場合MissingResourceException
- 指定された基底名のリソースバンドルが見つからない場合public static final ResourceBundle getBundle(String baseName, ResourceBundle.Control control)
getBundle(baseName, Locale.getDefault(), this.getClass().getClassLoader(), control),
getClassLoader()
が、ResourceBundle
のセキュリティー特権により実行されることだけが異なります。ResourceBundle.Control
を使用したリソースバンドルロード処理の詳細は、getBundle
を参照してください。baseName
- リソースバンドルの基底名。完全指定クラス名control
- リソースバンドルロード処理のための情報を提供するコントロールNullPointerException
- baseName
または control
が null
である場合MissingResourceException
- 指定された基底名のリソースバンドルが見つからない場合IllegalArgumentException
- 指定された control
が正しく実行されない場合 (たとえば、control.getCandidateLocales
が null を返す場合)。control
の検証が必要に応じて実行されることに注意。public static final ResourceBundle getBundle(String baseName, Locale locale)
getBundle(baseName, locale, this.getClass().getClassLoader())
,
getClassLoader()
が、ResourceBundle
のセキュリティー特権により実行されることだけが異なります。検索とインスタンス化の方法の詳細は、getBundle
を参照してください。baseName
- リソースバンドルの基底名。完全指定クラス名locale
- リソースバンドルが必要なロケールNullPointerException
- baseName
または locale
が null
である場合MissingResourceException
- 指定された基底名のリソースバンドルが見つからない場合public static final ResourceBundle getBundle(String baseName, Locale targetLocale, ResourceBundle.Control control)
getBundle(baseName, targetLocale, this.getClass().getClassLoader(), control),
getClassLoader()
が、ResourceBundle
のセキュリティー特権により実行されることだけが異なります。ResourceBundle.Control
を使用したリソースバンドルロード処理の詳細は、getBundle
を参照してください。baseName
- リソースバンドルの基底名。完全指定クラス名targetLocale
- リソースバンドルが必要なロケールcontrol
- リソースバンドルロード処理のための情報を提供するコントロールlocales
内のある Locale
に対するリソースバンドルNullPointerException
- baseName
、locales
、または control
が null
の場合MissingResourceException
- locales
内のどのロケールにおいても指定された基底名のリソースバンドルが見つからない場合。IllegalArgumentException
- 指定された control
が正しく実行されない場合 (たとえば、control.getCandidateLocales
が null を返す場合)。control
の検証が必要に応じて実行されることに注意。public static ResourceBundle getBundle(String baseName, Locale locale, ClassLoader loader)
このメソッドの動作は、ResourceBundle.Control
のデフォルトインスタンスを渡して getBundle(String, Locale, ClassLoader, Control)
を呼び出す場合と同じになります。この動作について次に説明します。
getBundle
は、基底名、指定されたロケール、およびデフォルトのロケール (Locale.getDefault
から取得される) を使用して、候補のバンドル名のシーケンスを生成します。指定されたロケールの言語、スクリプト、国、およびバリアントがすべて空の文字列の場合、候補のバンドル名は基底名のみになります。それ以外の場合は、指定されたロケールの属性値 (言語、スクリプト、国、およびバリアント) から候補ロケールのリストが生成され、基底名に追加されます。通常、これは次のようになります。
baseName + "_" + language + "_" + script + "_" + country + "_" + variant baseName + "_" + language + "_" + script + "_" + country baseName + "_" + language + "_" + script baseName + "_" + language + "_" + country + "_" + variant baseName + "_" + language + "_" + country baseName + "_" + language
最終コンポーネントとして空の文字列を持つ候補のバンドル名は、下線とともに省略されます。たとえば、国が空の文字列の場合、上記のうち 2 番目と 5 番目の候補のバンドル名は省略されます。また、スクリプトが空の文字列の場合、スクリプトを含む候補名は省略されます。たとえば、ロケールの言語が「de」、バリアントが「JAVA」の場合は、基底名「MyResource」を使用して次の候補名が生成されます。
MyResource_de__JAVA MyResource_deバリアントに 1 つ以上の下線 (「_」) が含まれている場合は、最後の下線とそれに続く部分を切り捨てることによってバンドル名のシーケンスが生成され、元のバリアントを持つ候補バンドル名のあとに挿入されます。たとえば、ロケールの言語が「en」、スクリプトが「Latn」、国が「US」、バリアントが「WINDOWS_VISTA」で、バンドルの基底名が「MyResource」の場合は、次の候補バンドル名のリストが生成されます。
MyResource_en_Latn_US_WINDOWS_VISTA MyResource_en_Latn_US_WINDOWS MyResource_en_Latn_US MyResource_en_Latn MyResource_en_US_WINDOWS_VISTA MyResource_en_US_WINDOWS MyResource_en_US MyResource_en
注: 一部のLocale
では、候補のバンドル名のリストにほかの名前も含まれている場合や、バンドル名の順序が多少異なる場合があります。詳細は、getCandidateLocales
のデフォルト実装の説明を参照してください。
getBundle
は実際のリソースバンドルをインスタンス化できる最初の名前を見つけるために、候補のバンドル名を反復処理します。デフォルトのコントロールの getFormats
メソッドを使用して、生成された名前ごとに 2 つのバンドル名を生成します。その 1 つ目はクラス名で、2 つ目はプロパティーファイル名です。候補バンドル名ごとに、リソースバンドルを次のように作成しようとします。
getBundle
はこのクラスの新しいインスタンスを作成して、結果リソースバンドルとしてそのインスタンスを使用します。
getBundle
は生成されたプロパティーファイル名を使用してプロパティーリソースファイルを見つけようとします。すべての「.」文字を「/」文字に置き換え、「.properties」文字列を追加して、候補のバンドル名からパス名を生成します。ClassLoader.getResource
を使ってこの名前を持つ「リソース」の検索を試みます。(getResource
における「リソース」は、リソースバンドルの内容とはまったく関係なく、ファイルなどのデータコンテナにすぎないことに注意。)「リソース」を見つけた場合、リソースの内容から新しい PropertyResourceBundle
インスタンスを作成しようとします。成功した場合は、このインスタンスは、結果リソースバンドルになります。 結果リソースバンドルがインスタンス化されるか、候補バンドル名のリストが終わるまで、これが繰り返されます。一致するリソースバンドルが見つからない場合は、デフォルトのコントロールの getFallbackLocale
メソッドが呼び出されて、現在のデフォルトロケールが返されます。このロケールを使用して候補ロケール名の新しいシーケンスが生成され、それが上記のように再度検索されます。
それでもなお結果バンドルが見つからない場合は、単独の基底名が検索されます。これも失敗した場合は、MissingResourceException
がスローされます。
結果リソースバンドルが見つかったときは、その親連鎖をインスタンス化します。結果バンドルにすでに親が存在している場合 (おそらくキャッシュから返されたため)、連鎖は完成します。
それ以外の場合、getBundle
は、結果リソースバンドルが生成されたパスで使用された候補ロケールリストの残り部分を調べます。(前述したように、最終コンポーネントが空の文字列である場合、候補のバンドル名は省略されます。)候補リストの終わりに到達した場合は、単純なバンドル名を試します。候補のバンドル名ごとに、リソースバンドルのインスタンス化を試みます (前述したように、まずクラスを検索し、次にプロパティーファイルを検索します)。
それが成功するたびに、前にインスタンス化したリソースバンドルの setParent
メソッドを新しいリソースバンドルで呼び出します。名前のリストが終わるまで、または現在のバンドルに null 以外の親がまだ存在していないかぎり、これが繰り返されます。
親連鎖が完成したら、バンドルが返されます。
注: getBundle
は、インスタンス化したリソースバンドルをキャッシュし、同じリソースバンドルのインスタンスを複数回返す可能性があります。
注: baseName
引数は完全指定されたクラス名である必要があります。ただし、以前のバージョンとの互換性を保つために、Sun の Java SE Runtime Environment はそのことを検証しません。そのため、完全指定されたクラス名 (「.」を使用) の代わりにパス名 (「/」を使用) を指定して、PropertyResourceBundle
にアクセスすることができます。
次のクラスとプロパティーファイルが提供されています。
MyResources.class MyResources.properties MyResources_fr.properties MyResources_fr_CH.class MyResources_fr_CH.properties MyResources_en.properties MyResources_es_ES.classすべてのファイルの内容が有効です (つまり、「.class」ファイルは
ResourceBundle
の public 非抽象サブクラスを含んでおり、「.properties」ファイルは構文的に正しい)。デフォルトのロケールは Locale("en", "GB")
です。
getBundle
を次の引数で呼び出すと、リソースバンドルが次のようにインスタンス化されます。
Locale("fr", "CH") | MyResources_fr_CH.class, parent MyResources_fr.properties, parent MyResources.class |
Locale("fr", "FR") | MyResources_fr.properties, parent MyResources.class |
Locale("de", "DE") | MyResources_en.properties, parent MyResources.class |
Locale("en", "US") | MyResources_en.properties, parent MyResources.class |
Locale("es", "ES") | MyResources_es_ES.class, parent MyResources.class |
ファイル MyResources_fr_CH.properties が使用されることは決してありません。なぜなら、このファイルは MyResources_fr_CH.class によって隠蔽されるからです。同様に、MyResources.properties も MyResources.class によって隠蔽されます。
baseName
- リソースバンドルの基底名。完全指定クラス名locale
- リソースバンドルが必要なロケールloader
- リソースバンドルのロード元のクラスローダーNullPointerException
- baseName
、locale
、または loader
が null
の場合MissingResourceException
- 指定された基底名のリソースバンドルが見つからない場合public static ResourceBundle getBundle(String baseName, Locale targetLocale, ClassLoader loader, ResourceBundle.Control control)
control
引数のない getBundle
ファクトリメソッドとは異なり、指定された control
によって、リソースバンドルを検索およびインスタンス化する方法が決まります。基本的に、control
が指定された場合のバンドルロード処理の実行手順は、次のようになります。
baseName
、targetLocale
、および loader
に対するリソースバンドルを、キャッシュ内で検索します。要求されたリソースバンドルのインスタンスがキャッシュ内で見つかり、そのインスタンスとすべての親インスタンスの有効期間がまだ過ぎていない場合には、そのインスタンスが呼び出し元に返されます。それ以外の場合、このファクトリメソッドは次のロード処理へと進みます。control.getFormats
メソッドが呼び出され、リソースバンドル形式が取得されます。文字列 "java.class"
と "java.properties"
はそれぞれ、クラスベースのリソースバンドルとプロパティーベースのリソースバンドルを表します。"java."
で始まるその他の文字列は、将来の拡張用として予約されているため、アプリケーション定義形式では使用しないでください。その他の文字列は、アプリケーション定義形式を表します。control.getCandidateLocales
メソッドがターゲットロケールを指定して呼び出され、リソースバンドルの検索に使用される候補 Locale
のリストが取得されます。control.newBundle
メソッドが呼び出され、この基底バンドル名、ある候補ロケール、およびある形式に対する ResourceBundle
がインスタンス化されます。(後述のキャッシュ検索に関する注を参照。)この手順は候補ロケールと形式のすべての組み合わせについて反復され、newBundle
メソッドが ResourceBundle
インスタンスを返すかすべての組み合わせが使用された時点で終了します。たとえば、候補ロケールが Locale("de", "DE")
、Locale("de")
、および Locale("")
であり、形式が "java.class"
と "java.properties"
であった場合、control.newBundle
の呼び出し時に使用すべきロケールと形式の組み合わせのシーケンスは、次のようになります。
Locale | format |
Locale("de", "DE") | java.class |
Locale("de", "DE") | java.properties |
Locale("de") | java.class |
Locale("de") | java.properties |
Locale("") | java.class |
Locale("") | java.properties |
Locale("")
に対するバンドル) であり、候補ロケールリストに Locale("")
しか含まれていなかった場合には、そのバンドルを呼び出し元に返します。見つかったバンドルが基底バンドルであるが、候補ロケールリストに Locale("") 以外のロケールが含まれていた場合には、そのバンドルを保留して手順 6 に進みます。見つかったバンドルが基底バンドルでない場合は、手順 7 に進みます。control.getFallbackLocale
メソッドが呼び出され、フォールバックロケール (現在のターゲットロケールの代替となるロケール) が取得されます。このメソッドが null 以外のロケールを返した場合、それが次のターゲットロケールとなり、手順 3 からロード処理が開始されます。それ以外の場合、1 つ前の手順 5 で基底バンドルが見つかり、それを保留していた場合には、その基底バンドルがこの時点で呼び出し元に返されます。それ以外の場合は、MissingResourceException がスローされます。上記のリソースバンドルロード処理の間、このファクトリメソッドは、control.newBundle
メソッドを呼び出す前にキャッシュを検索します。キャッシュ内で見つかったリソースバンドルの有効期間が過ぎていた場合、ファクトリメソッドは control.needsReload
メソッドを呼び出し、そのリソースバンドルを再ロードする必要があるかどうかを判定します。再ロードが必要な場合、ファクトリメソッドは control.newBundle
を呼び出してリソースバンドルを再ロードします。control.newBundle
が null
を返した場合、ファクトリメソッドは、存在しないリソースバンドルの目印として、ダミーのリソースバンドルをキャッシュ内に格納します。これにより、後続の要求に対する検索オーバーヘッドを回避できます。そのようなダミーのリソースバンドルは、control
で指定されたのと同じ有効期限制御下に入ります。
デフォルトでは、ロードされたリソースバンドルのすべてがキャッシュに格納されます。詳細は、control.getTimeToLive
を参照してください。
デフォルトの ResourceBundle.Control
実装を使用したバンドルロード処理の例を、次に示します。
条件:
foo.bar.Messages
Locale
: Locale.ITALY
Locale
: Locale.FRENCH
foo/bar/Messages_fr.properties
および foo/bar/Messages.properties
まず、getBundle
は、次の順番でリソースバンドルのロードを試みます。
foo.bar.Messages_it_IT
foo/bar/Messages_it_IT.properties
foo.bar.Messages_it
foo/bar/Messages_it.properties
foo.bar.Messages
foo/bar/Messages.properties
この時点で、getBundle
は foo/bar/Messages.properties
を見つけますが、それを保留します。なぜなら、それは基底バンドルだからです。getBundle
は control.getFallbackLocale("foo.bar.Messages", Locale.ITALY)
を呼び出します。すると、Locale.FRENCH
が返されます。次に、getBundle
は次の順番でバンドルのロードを試みます。
foo.bar.Messages_fr
foo/bar/Messages_fr.properties
foo.bar.Messages
foo/bar/Messages.properties
getBundle
は foo/bar/Messages_fr.properties
を見つけ、ResourceBundle
インスタンスを作成します。次に、getBundle
は候補ロケールのリストに基づいて、その親連鎖を設定します。リスト内で見つかるのは foo/bar/Messages.properties
だけです。getBundle
は、foo/bar/Messages_fr.properties
に対するインスタンスの親になる ResourceBundle
インスタンスを作成します。
baseName
- リソースバンドルの基底名。完全指定クラス名targetLocale
- リソースバンドルが必要なロケールloader
- リソースバンドルのロード元のクラスローダーcontrol
- リソースバンドルロード処理のための情報を提供するコントロールNullPointerException
- baseName
、targetLocale
、loader
、または control
が null
の場合MissingResourceException
- 指定された基底名のリソースバンドルが見つからない場合IllegalArgumentException
- 指定された control
が正しく実行されない場合 (たとえば、control.getCandidateLocales
が null を返す場合)。control
の検証が必要に応じて実行されることに注意。public static final void clearCache()
ResourceBundle.Control.getTimeToLive(String,Locale)
public static final void clearCache(ClassLoader loader)
loader
- クラスローダーNullPointerException
- loader
が null である場合ResourceBundle.Control.getTimeToLive(String,Locale)
protected abstract Object handleGetObject(String key)
key
- 目的のオブジェクトのキーNullPointerException
- key
が null
である場合public abstract Enumeration<String> getKeys()
ResourceBundle
とその親バンドル内に含まれるキーの Enumeration
。public boolean containsKey(String key)
key
がこの ResourceBundle
またはその親バンドル内に含まれるかどうかを判定します。key
- リソースの key
key
がこの ResourceBundle
またはその親バンドル内に含まれる場合は true
、それ以外の場合は false
。NullPointerException
- key
が null
である場合public Set<String> keySet()
ResourceBundle
とその親バンドル内に含まれるすべてのキーの Set
を返します。ResourceBundle
とその親バンドル内に含まれるすべてのキーの Set
。protected Set<String> handleKeySet()
ResourceBundle
にのみ含まれるキーの Set
を返します。
デフォルト実装は、getKeys
メソッドから返されるキーの Set
を返します。ただし、handleGetObject
メソッドが null
を返すようなキーは除外されます。Set
が作成されると、その値がこの ResourceBundle
内に保存されます。これにより、次の呼び出し時に同じ Set
が生成されるのを防ぐことができます。サブクラスはこのメソッドをオーバーライドして、処理の高速化を図ることができます。
ResourceBundle
にのみ含まれているキーの Set
バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.