Класс ResourceBundle.Control

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

Возвращать неизменяемый (модифицировать который нельзя) List не обязательно. Однако возвращённый List нельзя изменять после того, как он был возвращён методом getFormats.

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

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

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

Возвращать неизменяемый (модифицировать который нельзя) List не обязательно. Однако возвращённый List нельзя изменять после того, как он был возвращён методом getCandidateLocales.

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

1. Для входной Locale с пустым значением скрипта добавляйте возможные Localeы, последовательно опуская конечную компоненту, как показано ниже:
   • [L, C, V]
   • [L, C]
   • [L]
   • Locale.ROOT
2. Для входной Locale с непустым значением скрипта добавляйте возможные Localeы, последовательно опуская конечные компоненты вплоть до языка, а затем добавьте кандидатов, сформированных из Locale с восстановленными значениями страны и варианта:
   • [L, S, C, V]
   • [L, S, C]
   • [L, S]
   • [L, C, V]
   • [L, C]
   • [L]
   • Locale.ROOT
3. Для входной Locale со значением варианта, состоящим из нескольких подметок, разделённых символом подчёркивания, сформируйте возможные Localeы, последовательно опуская подметки варианта, а затем вставьте их после каждого вхождения Localeов с полным значением варианта в исходном списке. Например, если вариант состоит из двух подметок 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. Особые случаи для китайского языка. Если во входной Locale указан язык "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") (обработанного выше), если во входной Locale указан язык "no" или "nb", возможные Localeы с кодами языков "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

    Messages_ja -> Messages

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

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

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

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

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

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

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

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

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

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

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

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