Класс 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.", зарезервированы для будущих расширений и не должны использоваться прикладными форматами.

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

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

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

Возвращает список кандидатов в качестве локалей для поиска ресурсов для baseName и 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"), то возвращается список кандидатов 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. То есть, если фабричный метод находит в кэше ресурсный пакет, срок действия которого истек, то фабричный метод вызывает метод 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 фабричный метод вызывает этот метод у экземпляра 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("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".