Класс 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 в неизменяемом (unmodifiable) виде не предъявляется. Однако, возвращаемый List не должен изменяться после возвращения методом getFormats.

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

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

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

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

Если заданная локаль равна 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
 

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

     Messages_ja -> Messages
 

public Locale getFallbackLocale(String baseName, Locale locale)

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

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

Реализация по умолчанию возвращает стандартную Locale, если заданная locale не является стандартной. В противном случае возвращается 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 равен 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".