Класс ResourceBundle.Control

public static final List<String> FORMAT_DEFAULT

Формат по умолчанию List, который содержит строки "java.class" и "java.properties", в этом порядке. Этот List не изменяется.

public static final List<String> FORMAT_CLASS

Формат только для класса List содержащий "java.class". Этот List не изменяется.

public static final List<String> FORMAT_PROPERTIES

Формат только для свойств List содержащий "java.properties". Этот List не изменяется.

public static final long TTL_DONT_CACHE

Константа времени жизни для некэширования загруженных экземпляров ресурсного пакета.

public static final long TTL_NO_EXPIRATION_CONTROL

Константа времени жизни для отключения контроля истечения срока действия загруженных экземпляров ресурсного пакета в кэше.

protected Control()

Единственный конструктор. (Для вызова конструкторами подклассов, обычно неявный.)

public static final ResourceBundle.Control getControl(List<String> formats)

Возвращает ResourceBundle.Control, в котором метод getFormats возвращает указанные formats. formats должен быть равен одному из FORMAT_PROPERTIES, FORMAT_CLASS или FORMAT_DEFAULT. Экземпляры ResourceBundle.Control возвращаемые этим методом являются синглтонами и потокобезопасными.

Указание FORMAT_DEFAULT эквивалентно созданию экземпляра класса ResourceBundle.Control, за исключением того, что этот метод возвращает синглтон.

public static final ResourceBundle.Control getNoFallbackControl(List<String> formats)

Возвращает ResourceBundle.Control, в котором метод getFormats возвращает указанные formats, а метод getFallbackLocale возвращает null. formats должен быть равен одному из FORMAT_PROPERTIES, FORMAT_CLASS или FORMAT_DEFAULT. Экземпляры ResourceBundle.Control возвращаемые этим методом являются синглтонами и потокобезопасными.

public List<String> getFormats(String baseName)

Возвращает List String содержащих форматы, используемые для загрузки ресурсных пакетов для заданного baseName. Метод фабрики ResourceBundle.getBundle пытается загрузить ресурсные пакеты с форматами в указанном в списке порядке. Возвращаемый этим методом список должен содержать как минимум один String. Предопределенные форматы - "java.class" для ресурсных пакетов на основе класса и "java.properties" для основанных на свойствах. Строки, начинающиеся с "java.", зарезервированы для будущих расширений и не должны использоваться для форматов, определённых приложением.

Необязательно возвращать неизменяемый (unmodifiable) List. Однако возвращаемый List не должен изменяться после возврата методом getFormats.

Реализация по умолчанию возвращает FORMAT_DEFAULT, чтобы метод фабрики ResourceBundle.getBundle сначала искал ресурсные пакеты на основе класса, затем на основе свойств.

public List<Locale> getCandidateLocales(String baseName, Locale locale)

Возвращает список кандидатов из доступных языков, как кандидатов для Locale и locale. Этот метод вызывается фабричным методом ResourceBundle.getBundle каждый раз, когда фабричный метод пытается найти набор ресурсов для целевого Locale.

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

Если заданный язык равен Locale.ROOT (корневой язык), должен быть возвращен список, содержащий только корневой Locale. В этом случае, фабричный метод ResourceBundle.getBundle загружает только базовый набор как результирующий набор ресурсов.

Не обязательно возвращать неизменяемый (unmodifiable) список. Однако возвращённый список не должен изменяться после возвращения методом getCandidateLocales.

Реализация по умолчанию возвращает список, содержащий кандидатов, используя правила, описанные ниже. В описании ниже L, S, C и V соответственно обозначают непустой язык, сценарий, страну и вариант. Например, [L, C] представляет список, содержащий непустые значения только для языка и страны. Форма L("xx") означает, что (непустое) значение языка равно "xx". Во всех случаях списки, чьи значения конечного компонента являются пустой строкой, пропускаются.

1. Для входного языка со значением сценария, равным пустой строке, добавляются кандидаты, опуская конечный компонент по одному, как показано ниже:
   • [L, C, V]
   • [L, C]
   • [L]
   • Locale.ROOT
2. Для входного языка с непустым значением сценария, добавляются кандидаты, опуская конечный компонент до языка, затем добавляются кандидаты, сгенерированные из входного языка, с восстановленными страной и вариантом:
   • [L, S, C, V]
   • [L, S, C]
   • [L, S]
   • [L, C, V]
   • [L, C]
   • [L]
   • Locale.ROOT
3. Для входного языка со значением варианта, состоящего из нескольких подтегов, разделённых знаком нижнего подчёркивания, генерируются кандидаты, опуская подтеги варианта по одному, затем вставляются после каждого вхождения подтегов со значением полного варианта в исходном списке. Например, если вариант состоит из двух подтегов V1 и V2:
   • [L, S, C, V1, V2]
   • [L, S, C, V1]
   • [L, S, C]
   • [L, S]
   • [L, C, V1, V2]
   • [L, C, V1]
   • [L, C]
   • [L]
   • Locale.ROOT
4. Специальные случаи для китайского языка. Когда входной язык имеет язык "zh" (китайский) и пустое значение сценария, могут быть заданы либо "Hans" (упрощённый), либо "Hant" (традиционный), в зависимости от страны. Когда страна "CN" (Китай) или "SG" (Сингапур), используется "Hans". Когда страна "HK" (Гонконг), "MO" (Макао) или "TW" (Тайвань), используется "Hant". Для всех других стран или когда страна пуста, сценарий не задаётся. Например, для Locale("zh", "CN") , список кандидатов будет:
   • [L("zh"), S("Hans"), C("CN")]
   • [L("zh"), S("Hans")]
   • [L("zh"), C("CN")]
   • [L("zh")]
   • Locale.ROOT
   Для Locale("zh", "TW"), список кандидатов будет:
   • [L("zh"), S("Hant"), C("TW")]
   • [L("zh"), S("Hant")]
   • [L("zh"), C("TW")]
   • [L("zh")]
   • Locale.ROOT
5. Специальные случаи для норвежского языка. Как Locale("no", "NO", "NY"), так и Locale("nn", "NO") представляют норвежский нюнорск. Когда языком локализации является "nn", генерируется стандартный список кандидатов до [L("nn")], а затем добавляются следующие кандидаты:
   • [L("no"), C("NO"), V("NY")]
   • [L("no"), C("NO")]
   • [L("no")]
   • Locale.ROOT
   Если локаль точно равна Locale("no", "NO", "NY"), она сначала преобразуется в Locale("nn", "NO"), а затем применяется указанный выше алгоритм.

   Также, Java считает язык "no" синонимом норвежского бокмола "nb". За исключением отдельного случая Locale("no", "NO", "NY") (обработанного выше), когда входной язык имеет язык "no" или "nb", кандидаты со значениями языка "no" и "nb" чередуются, сначала с запрошенным языком, затем с его синонимом. Например, Locale("nb", "NO", "POSIX") генерирует следующий список кандидатов:

   • [L("nb"), C("NO"), V("POSIX")]
   • [L("no"), C("NO"), V("POSIX")]
   • [L("nb"), C("NO")]
   • [L("no"), C("NO")]
   • [L("nb")]
   • [L("no")]
   • Locale.ROOT
   Locale("no", "NO", "POSIX") сгенерирует тот же список, за исключением того, что локали с "no" будут появляться перед соответствующими локали с "nb".

Реализация по умолчанию использует ArrayList, которую реализации, переопределяющие этот метод, могут изменить перед возвратом вызывающей стороне. Однако подкласс не должен изменять её после возвращения методом getCandidateLocales.

Например, если заданный baseName - "Messages", а заданный locale - Locale("ja", "", "XX"), то список List из Locale возвращается:

     Locale("ja", "", "XX")
     Locale("ja")
     Locale.ROOT
 

Возвращается. И если ресурсы для "ja" и пустые Locale найдены, то путь поиска ресурсов во время выполнения (цепь предков) будет

     Messages_ja -> Messages
 

public Locale getFallbackLocale(String baseName, Locale locale)

Возвращает язык, который будет использоваться как язык по умолчанию для дальнейшего поиска наборов ресурсов фабричным методом ResourceBundle.getBundle. Этот метод вызывается из фабричного метода каждый раз, когда для baseName и locale не удалось найти результирующий набор ресурсов, где язык является параметром для ResourceBundle.getBundle или предыдущим языком по умолчанию, возвращенным этим методом.

Метод возвращает null если дальнейший поиск по умолчанию не требуется.

Реализация по умолчанию возвращает стандартный язык, если заданный язык не является стандартным. В противном случае, возвращается null.

public ResourceBundle newBundle(String baseName, Locale locale, String format, ClassLoader loader, boolean reload) throws IllegalAccessException, InstantiationException, IOException

Инициализирует ресурсный пакет для заданного имени пакета, формата и региона, используя заданный загрузчик классов при необходимости. Этот метод возвращает null , если для заданных параметров нет ресурсного пакета. Если ресурсный пакет нельзя инициализировать из-за непредвиденной ошибки, ошибка должна быть сообщена путём выброса Error или Exception, а не простым возвращением null.

Флаг reload равен true, если этот метод вызывается, потому что ранее загруженный ресурсный пакет истек.

public long getTimeToLive(String baseName, Locale locale)

Возвращает значение времени жизни (TTL) для ресурсных пакетов, загруженных в этом ResourceBundle.Control. Положительные значения времени жизни задают количество миллисекунд, в течение которого пакет может оставаться в кэше, не проверяясь на соответствие исходным данным, из которых он был создан. Значение 0 указывает, что пакет должен проверяться каждый раз при извлечении из кэша. TTL_DONT_CACHE указывает, что загруженные ресурсные пакеты не помещаются в кэш. TTL_NO_EXPIRATION_CONTROL указывает, что загруженные ресурсные пакеты помещаются в кэш без контроля истечения срока действия.

Истечение срока действия влияет только на процесс загрузки пакета методом ResourceBundle.getBundle factory. То есть, если метод factory находит в кэше ресурсный пакет, срок действия которого истек, метод factory вызывает метод needsReload, чтобы определить, требуется ли перезагрузка ресурсного пакета. Если needsReload возвращает true, экземпляр кэшированного ресурсного пакета удаляется из кэша. В противном случае экземпляр остаётся в кэше, обновлённый с новым значением TTL, возвращённым этим методом.

Все кэшированные ресурсные пакеты могут быть удалены из кэша из-за ограничений памяти среды выполнения. Возврат большого положительного значения не означает блокировки загруженных ресурсных пакетов в кэше.

В реализации по умолчанию возвращается TTL_NO_EXPIRATION_CONTROL.

public boolean needsReload(String baseName, Locale locale, String format, ClassLoader loader, ResourceBundle bundle, long loadTime)

Определяет, нужно ли перезагружать истекший bundle в кэше, основываясь на времени загрузки, указанном в loadTime, или на каких-либо других критериях. Метод возвращает true , если перезагрузка требуется; false в противном случае. loadTime — смещение в миллисекундах с момента Calendar эпохи.

Вызывающий ResourceBundle.getBundle factory метод вызывает этот метод на экземпляре ResourceBundle.Control , используемом для текущего вызова, а не на экземпляре, используемом при вызове, который изначально загрузил ресурсный пакет.

В реализации по умолчанию сравнивается loadTime и время последнего изменения исходных данных ресурсного пакета. Если установлено, что исходные данные изменены после loadTime, возвращается true. В противном случае возвращается false. Эта реализация предполагает, что данный format — это та же строка, что и его суффикс файла, если он не является одним из форматов по умолчанию, "java.class" или "java.properties".

public String toBundleName(String baseName, Locale locale)

Преобразует заданное baseName и locale в имя набора ресурсов. Этот метод вызывается из реализации по умолчанию методов newBundle и needsReload.

Эта реализация возвращает следующее значение:

     baseName + "_" + language + "_" + script + "_" + country + "_" + variant
 

где language, script, country, и variant — соответственно значения языка, сценария, страны и варианта locale. Конечные компоненты со значением пустой строки опускаются вместе с предшествующим '_'. Если сценарий пустой, значение сценария опускается вместе с предшествующим '_'. Если все значения являются пустыми строками, возвращается baseName.

Например, если baseName равно "baseName" и locale равно Locale("ja", "", "XX"), то возвращается "baseName_ja_ _XX". Если заданный locale равен Locale("en"), то возвращается "baseName_en".

Переопределение этого метода позволяет приложениям использовать различные соглашения при организации и упаковке локализованных ресурсов.

public final String toResourceName(String bundleName, String suffix)

Преобразует заданное bundleName в формат, необходимый методу ClassLoader.getResource, заменяя все вхождения '.' в bundleName на '/' и добавляя '.' и заданный тип файла suffix. Например, если bundleName равно "foo.bar.MyResources_ja_JP" и suffix равно "properties", то возвращается "foo/bar/MyResources_ja_JP.properties".