Класс ResourceBundle

(String) getObject(key).

(String[]) getObject(key).

getBundle(baseName, Locale.getDefault(), callerModule),

 getBundle(baseName, Locale.getDefault(),
           this.getClass().getClassLoader(), control),
 

getBundle(baseName, locale, callerModule),

getBundle(baseName, Locale.getDefault(), module)

Связки ресурсов в именованных модулях могут быть инкапсулированы. Когда связка ресурсов загружается из поставщика сервисов, вызывающему модулю необходимо иметь соответствующую строку uses в его описании модуля, чтобы объявить, что модуль использует ResourceBundleProvider для указанной связки ресурсов. В противном случае, он загрузит связки ресурсов, которые находятся локально в данном модуле, как если бы вызывал Module.getResourceAsStream(String), или которые видны загрузчику классов данного модуля, как если бы вызывал ClassLoader.getResourceAsStream(String). Когда связка ресурсов загружается из указанного модуля, она подчиняется правилам инкапсуляции, указанным в Module.getResourceAsStream.

Если указанный module является безымянным модулем, то этот метод эквивалентен вызову getBundle(baseName, targetLocale, module.getClassLoader() для загрузки связок ресурсов, которые видны загрузчику классов данного безымянного модуля. Пользовательские реализации ResourceBundleControlProvider, если они присутствуют, будут вызваны только если указанный модуль является безымянным.

 getBundle(baseName, targetLocale, this.getClass().getClassLoader(),
           control),
 

Когда этот метод вызывается из именованного модуля и предоставленный загрузчик является загрузчиком классов вызывающего модуля, это эквивалентно вызову:

 getBundle(baseName, targetLocale, callerModule)
 

 getBundle(baseName, targetLocale, loader, 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
 

Имена кандидатов, где конечный компонент является пустой строкой, пропускаются вместе с символом подчёркивания. Например, если страна является пустой строкой, второе и пятое имена кандидатов выше будут пропущены. Также, если сценарий является пустой строкой, имена кандидатов, содержащие сценарий, будут пропущены. Например, локаль с языком "de" и вариантом "JAVA" сгенерирует имена кандидатов с базовым именем "MyResource" ниже.

     MyResource_de__JAVA
     MyResource_de
 

 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 по умолчанию для управления, который генерирует два имени набора ресурсов для каждого сгенерированного имени, первое — имя класса, а второе — имя файла свойств. Для каждого имени кандидата он пытается создать набор ресурсов:

• Сначала он пытается загрузить класс, используя сгенерированное имя класса. Если такой класс можно найти и загрузить с помощью указанного загрузчика классов, он совместим по присваиванию с ResourceBundle, доступен из ResourceBundle и может быть создан, getBundle создаёт новый экземпляр этого класса и использует его в качестве результата набора ресурсов.
• В противном случае, getBundle пытается найти файл свойств ресурсов, используя сгенерированное имя файла свойств. Он генерирует имя пути из имени кандидата, заменяя все символы "." на "/" и добавляя строку ".properties". Он пытается найти "ресурс" с этим именем, используя ClassLoader.getResource. (Обратите внимание, что "ресурс" в смысле getResource не имеет ничего общего с содержимым набора ресурсов, он просто содержит данные, например, файл.) Если он находит "ресурс", он пытается создать новый экземпляр PropertyResourceBundle из его содержимого. При успехе этот экземпляр становится результатом набора ресурсов.

Это продолжается до тех пор, пока не будет создан набор ресурсов-результат или список имен кандидатов не будет исчерпан. Если соответствующий набор ресурсов не найден, вызывается метод getFallbackLocale управления по умолчанию, который возвращает текущую локаль по умолчанию. Новая последовательность имён кандидатов для локали генерируется с помощью этой локали и снова ищется, как описано выше.

Если набор ресурсов-результат всё ещё не найден, выполняется поиск по одному базовому имени. Если это тоже не удаётся, выбрасывается MissingResourceException.

После того, как был найден набор ресурсов-результат, создаётся его цепочка родительских наборов ресурсов. Если у набора результатов уже есть родитель (возможно, потому что он был возвращён из кэша), цепочка завершена.

В противном случае, getBundle проверяет оставшуюся часть списка кандидатов для локали, которая использовалась во время обработки, сгенерировавшей набор ресурсов-результат. (Как и раньше, имена кандидатов, где конечный компонент является пустой строкой, пропускаются.) Когда доходит до конца списка кандидатов, он пытается получить простое имя набора ресурсов. Для каждого из имен кандидатов он пытается создать набор ресурсов (сначала ищет класс, а затем файл свойств, как описано выше).

Всякий раз, когда это удаётся, он вызывает метод setParent ранее созданного набора ресурсов с новым набором ресурсов. Это продолжается до тех пор, пока список имён не будет исчерпан или текущий набор ресурсов уже не имеет родительского набора ресурсов, отличного от null.

После завершения цепочки родительских наборов ресурсов набор ресурсов возвращается.

Примечание: getBundle кеширует созданные наборы ресурсов и может возвращать один и тот же экземпляр набора ресурсов несколько раз.

Примечание: Аргумент baseName должен быть полным именем класса. Однако для совместимости со старыми версиями Java SE Runtime Environments это не проверяется, поэтому можно получить доступ к PropertyResourceBundle, указав имя пути (используя "/") вместо полного имени класса (используя ".").

Пример:

Предоставляются следующие классы и файлы свойств:

• MyResources.class
• MyResources.properties
• MyResources_fr.properties
• MyResources_fr_CH.class
• MyResources_fr_CH.properties
• MyResources_en.properties
• MyResources_es_ES.class

Вызов getBundle с приведенными ниже аргументами локали приведет к созданию наборов ресурсов следующим образом:

Файл MyResources_fr_CH.properties никогда не используется, потому что он скрыт MyResources_fr_CH.class. Аналогично, MyResources.properties также скрыт MyResources.class.

1. Этот метод-фабрика ищет ресурсный пакет в кэше для указанного baseName, targetLocale и loader. Если запрашиваемый экземпляр ресурсного пакета найден в кэше и периоды времени жизни экземпляра и всех его родительских экземпляров не истекли, экземпляр возвращается вызывающей стороне. В противном случае этот метод-фабрика продолжает процесс загрузки, описанный ниже.
2. Вызывается метод control.getFormats, чтобы получить форматы ресурсного пакета для создания имен пакета или ресурса. Строки "java.class" и "java.properties" обозначают ресурсные пакеты на основе классов и на основе свойств соответственно. Другие строки, начинающиеся с "java.", зарезервированы для будущих расширений и не должны использоваться для форматов, определенных приложением. Другие строки обозначают форматы, определенные приложением.
3. Метод control.getCandidateLocales вызывается с целевым языком, чтобы получить список кандидатных Locale, для которых ищутся ресурсные пакеты.
4. Метод control.newBundle вызывается для создания экземпляра ResourceBundle для имени базового пакета, кандидатного языка и формата. (Обратитесь к примечанию о поиске в кэше ниже.) Этот шаг повторяется для всех комбинаций кандидатов языков и форматов, пока метод newBundle не вернет экземпляр ResourceBundle или пока все комбинации не будут исчерпаны. Например, если кандидатами являются Locale("de", "DE"), Locale("de") и Locale(""), а форматами "java.class" и "java.properties", то следующая последовательность комбинаций язык-формат будет использоваться для вызова control.newBundle.

   комбинации язык-формат для newBundle

   Индекс	Locale	format
   1	Locale("de", "DE")	java.class
   2	Locale("de", "DE")	java.properties
   3	Locale("de")	java.class
   4	Locale("de")	java.properties
   5	Locale("")	java.class
   6	Locale("")	java.properties

5. Если на предыдущем шаге ресурсный пакет не найден, переходите к шагу 6. Если найден пакет, являющийся базовым пакетом (пакетом для Locale("")), и список кандидатов языков содержал только Locale(""), верните пакет вызывающей стороне. Если пакет, который был найден, является базовым пакетом, но список кандидатов языков содержал языки, отличные от Locale(""), задержите пакет и переходите к шагу 6. Если найден пакет, который не является базовым, переходите к шагу 7.
6. Вызывается метод control.getFallbackLocale, чтобы получить язык по умолчанию (альтернатива текущему целевому языку) для дальнейшего поиска ресурсного пакета. Если метод возвращает ненулевой язык, он становится новым целевым языком, и процесс загрузки начинается заново с шага 3. В противном случае, если базовый пакет был найден и приостановлен на предыдущем шаге 5, он возвращается вызывающей стороне. В противном случае выбрасывается MissingResourceException.
7. На этом этапе мы нашли ресурсный пакет, который не является базовым. Если этот пакет установил родительский пакет во время его создания, он возвращается вызывающей стороне. В противном случае его цепочка родителей создается на основе списка кандидатов языков, из которых он был найден. Наконец, пакет возвращается вызывающей стороне.

Во время процесса загрузки ресурсного пакета выше, этот метод-фабрика ищет в кэше перед вызовом метода 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 создает экземпляр ResourceBundle, который становится родителем экземпляра для foo/bar/Messages_fr.properties.

Реализация по умолчанию возвращает Set ключей, возвращаемых методом getKeys, за исключением тех, для которых метод handleGetObject возвращает null. После создания Set, значение сохраняется в этом ResourceBundle для предотвращения получения одного и того же Set в последующих вызовах. Подклассы могут переопределять этот метод для более быстрого обработки.