モジュール java.base
パッケージ java.util

クラスPropertyResourceBundle

java.lang.Object
java.util.ResourceBundle
java.util.PropertyResourceBundle
public class PropertyResourceBundle
extends ResourceBundle
PropertyResourceBundleは、プロパティ・ファイルからの一連のstatic文字列を使用してロケール用のリソースを管理する、ResourceBundleの具象サブクラスです。 リソース・バンドルの詳細については、ResourceBundleを参照してください。

ほかのタイプのリソース・バンドルと違い、PropertyResourceBundleはサブクラス化されません。 代わりに、リソース・データを格納するプロパティ・ファイルを提供します。 ResourceBundle.getBundleは、自動的に適切なプロパティ・ファイルを探し、そのファイルを参照するPropertyResourceBundleを作成します。 検索とインスタンス化の方法の詳細は、ResourceBundle.getBundleを参照してください。

次の例は、ベース名MyResourcesのリソース・バンドル・ファミリのメンバーを示しています。 テキストでは、バンドル・ファミリのドイツ・メンバーであるバンドル「MyResources_de」を定義します。 このメンバーはPropertyResourceBundleに基づいているため、テキストはMyResources_de.propertiesファイルの内容です(関連する例は、ListResourceBundleのサブクラスとして実装されるバンドルをこのファミリに追加する方法を示しています)。 この例のキーの形式は「s1」などです。実際のキーは、バンドルからオブジェクトを取り出すためにプログラムで使用するキーと同じであるかぎり、なんでもかまいません。 キーには、大文字/小文字の区別があります。 

 # MessageFormat pattern
 s1=Die Platte \"{1}\" enthält {0}.

 # location of {0} in pattern
 s2=1

 # sample disk name
 s3=Meine Platte

 # first ChoiceFormat choice
 s4=keine Dateien

 # second ChoiceFormat choice
 s5=eine Datei

 # third ChoiceFormat choice
 s6={0,number} Dateien

 # sample date
 s7=3. März 1996

APIのノート:
PropertyResourceBundleは、プロパティ・ファイルを表すInputStreamまたはReaderから作成できます。 InputStreamからPropertyResourceBundleインスタンスを構築するには、入力ストリームをUTF-8でエンコードする必要があります。 デフォルトでは、入力ストリームの読み取り時にMalformedInputExceptionまたはUnmappableCharacterExceptionが発生すると、PropertyResourceBundleインスタンスは例外の前の状態にリセットされ、ISO-8859-1で入力ストリームを再読み込みして読み取りを続けます。 システム・プロパティjava.util.PropertyResourceBundle.encodingが"ISO-8859-1"または"UTF-8"に設定されている場合、入力ストリームはそのエンコードでのみ読み取られ、無効な順序が検出されると例外がスローされます。 "ISO-8859-1"が指定されている場合、ISO-8859-1エンコーディングで表現できない文字は「Java言語仕様」の3.3セクションで定義されているUnicodeエスケープで表現する必要がありますが、Readerを使用する他のコンストラクタにはこの制限はありません。 このシステム・プロパティでは、他のエンコーディング値は無視されます。 このクラスを初期化するときにシステム・プロパティが読み込まれ、評価されます。 プロパティの変更または削除は、初期化後は無効です。
実装要件:
PropertyResourceBundleサブクラスの実装は、それが複数のスレッドで同時に使用される場合、スレッドセーフである必要があります。 このクラスの非抽象メソッドのデフォルト実装はスレッドセーフです。
導入されたバージョン:
1.1
関連項目:
ResourceBundle, ListResourceBundle, Properties

  • コンストラクタの詳細

    • PropertyResourceBundle

      public PropertyResourceBundle​(InputStream stream) throws IOException
      InputStreamからプロパティ・リソース・バンドルを作成します。 このコンストラクタは、デフォルトでUTF-8でプロパティ・ファイルを読み取ります。 入力ストリームの読み取り時にMalformedInputExceptionまたはUnmappableCharacterExceptionが発生した場合、PropertyResourceBundleインスタンスは例外の前の状態にリセットされ、ISO-8859-1の入力ストリームを再読み込みして読み取りを続けます。 システム・プロパティjava.util.PropertyResourceBundle.encodingが"ISO-8859-1"または"UTF-8"のいずれかに設定されている場合、入力ストリームはそのエンコーディングでのみ読み込まれ、無効なシーケンスに遭遇すると例外がスローされます。 このシステム・プロパティでは、他のエンコーディング値は無視されます。 このクラスを初期化するときにシステム・プロパティが読み込まれ、評価されます。 プロパティの変更または削除は、初期化後は無効です。
      パラメータ:
      stream - 読取り元のプロパティ・ファイルを表すInputStream。
      例外:
      IOException - 入出力エラーが発生した場合
      NullPointerException - streamがnullである場合
      IllegalArgumentException - streamに形式が不正なUnicodeエスケープ・シーケンスが含まれる場合。
      MalformedInputException - システム・プロパティjava.util.PropertyResourceBundle.encodingが"UTF-8"に設定され、streamに無効なUTF-8バイト・シーケンスが含まれている場合。
      UnmappableCharacterException - システム・プロパティjava.util.PropertyResourceBundle.encodingが"UTF-8"に設定され、streamにマッピング不可能なUTF-8バイト・シーケンスが含まれている場合。

    • PropertyResourceBundle

      public PropertyResourceBundle​(Reader reader) throws IOException
      Readerからプロパティ・リソース・バンドルを作成します。 コンストラクタPropertyResourceBundle(InputStream)の場合と異なり、入力プロパティ・ファイルのエンコーディングに関する制限はありません。
      パラメータ:
      reader - 読取り元のプロパティ・ファイルを表すReader。
      例外:
      IOException - 入出力エラーが発生した場合
      NullPointerException - readerがnullである場合
      IllegalArgumentException - readerから形式が不正なUnicodeエスケープ・シーケンスが出現する場合。
      導入されたバージョン:
      1.6

  • メソッドの詳細

    • getKeys

      public Enumeration<String> getKeys()
      このResourceBundleとその親バンドル内に含まれるキーのEnumerationを返します。
      定義:
      getKeys、クラス: ResourceBundle
      戻り値:
      このResourceBundleとその親バンドル内に含まれるキーのEnumeration。
      関連項目:
      ResourceBundle.keySet()

    • handleKeySet

      protected Set<String> handleKeySet()
      このResourceBundleにのみ含まれるキーのSetを返します。
      オーバーライド:
      handleKeySet、クラス: ResourceBundle
      戻り値:
      このResourceBundleにのみ含まれているキーのSet
      導入されたバージョン:
      1.6
      関連項目:
      ResourceBundle.keySet()