# PropertyResourceBundle Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # PropertyResourceBundle ``` open class PropertyResourceBundle : ResourceBundle ``` |---|---|----------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||| | ↳ | [java.util.ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle) || | | ↳ | [java.util.PropertyResourceBundle](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#) | `PropertyResourceBundle`is a concrete subclass of`ResourceBundle`that manages resources for a locale using a set of static strings from a property file. See[ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)for more information about resource bundles. Unlike other types of resource bundle, you don't subclass`PropertyResourceBundle`. Instead, you supply properties files containing the resource data.`ResourceBundle.getBundle`will automatically look for the appropriate properties file and create a`PropertyResourceBundle`that refers to it. See[ResourceBundle.getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.lang.ClassLoader))for a complete description of the search and instantiation strategy. The following example shows a member of a resource bundle family with the base name "MyResources". The text defines the bundle "MyResources_de", the German member of the bundle family. This member is based on`PropertyResourceBundle`, and the text therefore is the content of the file "MyResources_de.properties" (a related[example](https://developer.android.com/reference/kotlin/java/util/ListResourceBundle#sample)shows how you can add bundles to this family that are implemented as subclasses of`ListResourceBundle`). The keys in this example are of the form "s1" etc. The actual keys are entirely up to your choice, so long as they are the same as the keys you use in your program to retrieve the objects from the bundle. Keys are case-sensitive. ```kotlin MessageFormat pattern s1=Die Platte \"{1}\" enthält {0}. # location of {0} in pattern s2=1 # sample disk name s3=Meine Platte # first ChoiceFormat choice s4=keine Dateien # second ChoiceFormat choice s5=eine Datei # third ChoiceFormat choice s6={0,number} Dateien # sample date s7=3. März 1996 ``` ## Summary | Public constructors || |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---| | [PropertyResourceBundle](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#PropertyResourceBundle(java.io.InputStream))`(`stream:` `[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!`)` Creates a property resource bundle from an[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#). | | [PropertyResourceBundle](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#PropertyResourceBundle(java.io.Reader))`(`reader:` `[Reader](https://developer.android.com/reference/kotlin/java/io/Reader.html#)!`)` Creates a property resource bundle from a[Reader](https://developer.android.com/reference/kotlin/java/io/Reader.html#). | | Public methods || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[Enumeration](https://developer.android.com/reference/kotlin/java/util/Enumeration)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>! | [getKeys](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#getKeys())`()` Returns an`Enumeration`of the keys contained in this`ResourceBundle`and its parent bundles. | | open[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | [handleGetObject](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#handleGetObject(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
| | Protected methods || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)\<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\>! | [handleKeySet](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#handleKeySet())`()` Returns a`Set`of the keys contained*only* in this`ResourceBundle`. | | Inherited functions || |---|---| | From class[ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle) |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [clearCache](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#clearCache())`()`
Removes all resource bundles from the cache that have been loaded using the caller's class loader.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [clearCache](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#clearCache(java.lang.ClassLoader))`(`loader:` `[ClassLoader](https://developer.android.com/reference/kotlin/java/lang/ClassLoader.html#)!`)`
Removes all resource bundles from the cache that have been loaded by the given class loader.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [containsKey](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#containsKey(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Determines whether the given`key`is contained in this`ResourceBundle`or its parent bundles.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getBaseBundleName](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBaseBundleName())`()`
Returns the base name of this bundle, if known, or`null`if unknown. If not null, then this is the value of the`baseName`parameter that was passed to the`ResourceBundle.getBundle(...)`method when the resource bundle was loaded.
| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String))`(`baseName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Gets a resource bundle using the specified base name, the default locale, and the caller's class loader. Calling this method is equivalent to calling`getBundle(baseName, Locale.getDefault(), this.getClass().getClassLoader())`,
| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale))`(`baseName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `locale:` `[Locale](https://developer.android.com/reference/kotlin/java/util/Locale)!`)`
Gets a resource bundle using the specified base name and locale, and the caller's class loader. Calling this method is equivalent to calling`getBundle(baseName, locale, this.getClass().getClassLoader())`,
| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.lang.ClassLoader))`(`baseName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `locale:` `[Locale](https://developer.android.com/reference/kotlin/java/util/Locale)!`, `loader:` `[ClassLoader](https://developer.android.com/reference/kotlin/java/lang/ClassLoader.html#)!`)`
Gets a resource bundle using the specified base name, locale, and class loader. This is equivalent to calling: ```kotlin getBundle(baseName, targetLocale, loader, control) ``` passing a default instance of[Control](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control). Refer to the description of[modifying the default behavior](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#modify_default_behavior). The following describes the default behavior.
**Resource Bundle Search and Loading Strategy** `getBundle`uses the base name, the specified locale, and the default locale (obtained from[Locale.getDefault](https://developer.android.com/reference/kotlin/java/util/Locale#getDefault())) to generate a sequence of*candidate bundle names*. If the specified locale's language, script, country, and variant are all empty strings, then the base name is the only candidate bundle name. Otherwise, a list of candidate locales is generated from the attribute values of the specified locale (language, script, country and variant) and appended to the base name. Typically, this will look like the following: ```kotlin baseName + "_" + language + "_" + script + "_" + country + "_" + variant baseName + "_" + language + "_" + script + "_" + country baseName + "_" + language + "_" + script baseName + "_" + language + "_" + country + "_" + variant baseName + "_" + language + "_" + country baseName + "_" + language ``` Candidate bundle names where the final component is an empty string are omitted, along with the underscore. For example, if country is an empty string, the second and the fifth candidate bundle names above would be omitted. Also, if script is an empty string, the candidate names including script are omitted. For example, a locale with language "de" and variant "JAVA" will produce candidate names with base name "MyResource" below. ```kotlin MyResource_de__JAVA MyResource_de ``` In the case that the variant contains one or more underscores ('_'), a sequence of bundle names generated by truncating the last underscore and the part following it is inserted after a candidate bundle name with the original variant. For example, for a locale with language "en", script "Latn, country "US" and variant "WINDOWS_VISTA", and bundle base name "MyResource", the list of candidate bundle names below is generated: ```kotlin 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 ``` **Note:** For some`Locale`s, the list of candidate bundle names contains extra names, or the order of bundle names is slightly modified. See the description of the default implementation of[getCandidateLocales](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getCandidateLocales(kotlin.String,%20java.util.Locale))for details. `getBundle`then iterates over the candidate bundle names to find the first one for which it can*instantiate* an actual resource bundle. It uses the default controls'[getFormats](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getFormats(kotlin.String))method, which generates two bundle names for each generated name, the first a class name and the second a properties file name. For each candidate bundle name, it attempts to create a resource bundle: - First, it attempts to load a class using the generated class name. If such a class can be found and loaded using the specified class loader, is assignment compatible with ResourceBundle, is accessible from ResourceBundle, and can be instantiated,`getBundle`creates a new instance of this class and uses it as the*result resource bundle*. - Otherwise,`getBundle`attempts to locate a property resource file using the generated properties file name. It generates a path name from the candidate bundle name by replacing all "." characters with "/" and appending the string ".properties". It attempts to find a "resource" with this name using[ClassLoader.getResource](https://developer.android.com/reference/kotlin/java/lang/ClassLoader.html#getResource(kotlin.String)). (Note that a "resource" in the sense of`getResource`has nothing to do with the contents of a resource bundle, it is just a container of data, such as a file.) If it finds a "resource", it attempts to create a new[PropertyResourceBundle](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#)instance from its contents. If successful, this instance becomes the*result resource bundle*. This continues until a result resource bundle is instantiated or the list of candidate bundle names is exhausted. If no matching resource bundle is found, the default control's[getFallbackLocale](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getFallbackLocale(kotlin.String,%20java.util.Locale))method is called, which returns the current default locale. A new sequence of candidate locale names is generated using this locale and searched again, as above. If still no result bundle is found, the base name alone is looked up. If this still fails, a`MissingResourceException`is thrown. Once a result resource bundle has been found, its*parent chain*is instantiated. If the result bundle already has a parent (perhaps because it was returned from a cache) the chain is complete. Otherwise,`getBundle`examines the remainder of the candidate locale list that was used during the pass that generated the result resource bundle. (As before, candidate bundle names where the final component is an empty string are omitted.) When it comes to the end of the candidate list, it tries the plain bundle name. With each of the candidate bundle names it attempts to instantiate a resource bundle (first looking for a class and then a properties file, as described above). Whenever it succeeds, it calls the previously instantiated resource bundle's[setParent](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#setParent(java.util.ResourceBundle))method with the new resource bundle. This continues until the list of names is exhausted or the current bundle already has a non-null parent. Once the parent chain is complete, the bundle is returned. **Note:** `getBundle`caches instantiated resource bundles and might return the same resource bundle instance multiple times. **Note:** The`baseName`argument should be a fully qualified class name. However, for compatibility with earlier versions, Java SE Runtime Environments do not verify this, and so it is possible to access`PropertyResourceBundle`s by specifying a path name (using "/") instead of a fully qualified class name (using "."). **Example:** The following class and property files are provided: - MyResources.class - MyResources.properties - MyResources_fr.properties - MyResources_fr_CH.class - MyResources_fr_CH.properties - MyResources_en.properties - MyResources_es_ES.class The contents of all files are valid (that is, public non-abstract subclasses of`ResourceBundle`for the ".class" files, syntactically correct ".properties" files). The default locale is`Locale("en", "GB")`. Calling`getBundle`with the locale arguments below will instantiate resource bundles as follows: | Locale | Resource bundle | | Locale("fr", "CH") | MyResources_fr_CH.class, parent MyResources_fr.properties, parent MyResources.class | | Locale("fr", "FR") | MyResources_fr.properties, parent MyResources.class | | Locale("de", "DE") | MyResources_en.properties, parent MyResources.class | | Locale("en", "US") | MyResources_en.properties, parent MyResources.class | | Locale("es", "ES") | MyResources_es_ES.class, parent MyResources.class | |--------------------|-------------------------------------------------------------------------------------| The file MyResources_fr_CH.properties is never used because it is hidden by the MyResources_fr_CH.class. Likewise, MyResources.properties is also hidden by MyResources.class.
| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.lang.ClassLoader,%20java.util.ResourceBundle.Control))`(`baseName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `targetLocale:` `[Locale](https://developer.android.com/reference/kotlin/java/util/Locale)!`, `loader:` `[ClassLoader](https://developer.android.com/reference/kotlin/java/lang/ClassLoader.html#)!`, `control:` `[ResourceBundle.Control](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control)!`)`
Returns a resource bundle using the specified base name, target locale, class loader and control. Unlike the[getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.lang.ClassLoader))factory methods with no`control`argument, the given`control`specifies how to locate and instantiate resource bundles. Conceptually, the bundle loading process with the given`control`is performed in the following steps. 1. This factory method looks up the resource bundle in the cache for the specified`baseName`,`targetLocale`and`loader`. If the requested resource bundle instance is found in the cache and the time-to-live periods of the instance and all of its parent instances have not expired, the instance is returned to the caller. Otherwise, this factory method proceeds with the loading process below. 2. The[control.getFormats](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getFormats(kotlin.String))method is called to get resource bundle formats to produce bundle or resource names. The strings`"java.class"`and`"java.properties"`designate class-based and[property](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#)-based resource bundles, respectively. Other strings starting with`"java."`are reserved for future extensions and must not be used for application-defined formats. Other strings designate application-defined formats. 3. The[control.getCandidateLocales](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getCandidateLocales(kotlin.String,%20java.util.Locale))method is called with the target locale to get a list of*candidate`Locale`s*for which resource bundles are searched. 4. The[control.newBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#newBundle(kotlin.String,%20java.util.Locale,%20kotlin.String,%20java.lang.ClassLoader,%20kotlin.Boolean))method is called to instantiate a`ResourceBundle`for the base bundle name, a candidate locale, and a format. (Refer to the note on the cache lookup below.) This step is iterated over all combinations of the candidate locales and formats until the`newBundle`method returns a`ResourceBundle`instance or the iteration has used up all the combinations. For example, if the candidate locales are`Locale("de", "DE")`,`Locale("de")`and`Locale("")`and the formats are`"java.class"`and`"java.properties"`, then the following is the sequence of locale-format combinations to be used to call`control.newBundle`. | Index | `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. If the previous step has found no resource bundle, proceed to Step 6. If a bundle has been found that is a base bundle (a bundle for`Locale("")`), and the candidate locale list only contained`Locale("")`, return the bundle to the caller. If a bundle has been found that is a base bundle, but the candidate locale list contained locales other than Locale(""), put the bundle on hold and proceed to Step 6. If a bundle has been found that is not a base bundle, proceed to Step 7. 6. The[control.getFallbackLocale](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getFallbackLocale(kotlin.String,%20java.util.Locale))method is called to get a fallback locale (alternative to the current target locale) to try further finding a resource bundle. If the method returns a non-null locale, it becomes the next target locale and the loading process starts over from Step 3. Otherwise, if a base bundle was found and put on hold in a previous Step 5, it is returned to the caller now. Otherwise, a MissingResourceException is thrown. 7. At this point, we have found a resource bundle that's not the base bundle. If this bundle set its parent during its instantiation, it is returned to the caller. Otherwise, its[parent chain](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#parent_chain)is instantiated based on the list of candidate locales from which it was found. Finally, the bundle is returned to the caller.
During the resource bundle loading process above, this factory method looks up the cache before calling the[control.newBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#newBundle(kotlin.String,%20java.util.Locale,%20kotlin.String,%20java.lang.ClassLoader,%20kotlin.Boolean))method. If the time-to-live period of the resource bundle found in the cache has expired, the factory method calls the[control.needsReload](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#needsReload(kotlin.String,%20java.util.Locale,%20kotlin.String,%20java.lang.ClassLoader,%20java.util.ResourceBundle,%20kotlin.Long))method to determine whether the resource bundle needs to be reloaded. If reloading is required, the factory method calls`control.newBundle`to reload the resource bundle. If`control.newBundle`returns`null`, the factory method puts a dummy resource bundle in the cache as a mark of nonexistent resource bundles in order to avoid lookup overhead for subsequent requests. Such dummy resource bundles are under the same expiration control as specified by`control`. All resource bundles loaded are cached by default. Refer to[control.getTimeToLive](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getTimeToLive(kotlin.String,%20java.util.Locale))for details. The following is an example of the bundle loading process with the default`ResourceBundle.Control`implementation. Conditions: - Base bundle name:`foo.bar.Messages` - Requested`Locale`:[Locale.ITALY](https://developer.android.com/reference/kotlin/java/util/Locale#ITALY:java.util.Locale) - Default`Locale`:[Locale.FRENCH](https://developer.android.com/reference/kotlin/java/util/Locale#FRENCH:java.util.Locale) - Available resource bundles:`foo/bar/Messages_fr.properties`and`foo/bar/Messages.properties` First,`getBundle`tries loading a resource bundle in the following sequence. - class`foo.bar.Messages_it_IT` - file`foo/bar/Messages_it_IT.properties` - class`foo.bar.Messages_it` - file`foo/bar/Messages_it.properties` - class`foo.bar.Messages` - file`foo/bar/Messages.properties` At this point,`getBundle`finds`foo/bar/Messages.properties`, which is put on hold because it's the base bundle.`getBundle`calls[control.getFallbackLocale("foo.bar.Messages", Locale.ITALY)](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control#getFallbackLocale(kotlin.String,%20java.util.Locale))which returns`Locale.FRENCH`. Next,`getBundle`tries loading a bundle in the following sequence. - class`foo.bar.Messages_fr` - file`foo/bar/Messages_fr.properties` - class`foo.bar.Messages` - file`foo/bar/Messages.properties` `getBundle`finds`foo/bar/Messages_fr.properties`and creates a`ResourceBundle`instance. Then,`getBundle`sets up its parent chain from the list of the candidate locales. Only`foo/bar/Messages.properties`is found in the list and`getBundle`creates a`ResourceBundle`instance that becomes the parent of the instance for`foo/bar/Messages_fr.properties`.
| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.util.ResourceBundle.Control))`(`baseName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `targetLocale:` `[Locale](https://developer.android.com/reference/kotlin/java/util/Locale)!`, `control:` `[ResourceBundle.Control](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control)!`)`
Returns a resource bundle using the specified base name, target locale and control, and the caller's class loader. Calling this method is equivalent to calling ```kotlin getBundle(baseName, targetLocale, this.getClass().getClassLoader(), control), ``` except that`getClassLoader()`is run with the security privileges of`ResourceBundle`. See[getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.lang.ClassLoader,%20java.util.ResourceBundle.Control))for the complete description of the resource bundle loading process with a`ResourceBundle.Control`.

| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.ResourceBundle.Control))`(`baseName:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `control:` `[ResourceBundle.Control](https://developer.android.com/reference/kotlin/java/util/ResourceBundle.Control)!`)`
Returns a resource bundle using the specified base name, the default locale and the specified control. Calling this method is equivalent to calling ```kotlin getBundle(baseName, Locale.getDefault(), this.getClass().getClassLoader(), control), ``` except that`getClassLoader()`is run with the security privileges of`ResourceBundle`. See[getBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getBundle(kotlin.String,%20java.util.Locale,%20java.lang.ClassLoader,%20java.util.ResourceBundle.Control))for the complete description of the resource bundle loading process with a`ResourceBundle.Control`.

| | [Locale](https://developer.android.com/reference/kotlin/java/util/Locale)! | [getLocale](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getLocale())`()`
Returns the locale of this resource bundle. This method can be used after a call to getBundle() to determine whether the resource bundle returned really corresponds to the requested locale or is a fallback.
| | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | [getObject](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getObject(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Gets an object for the given key from this resource bundle or one of its parents. This method first tries to obtain the object from this resource bundle using[handleGetObject](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#handleGetObject(kotlin.String)). If not successful, and the parent resource bundle is not null, it calls the parent's`getObject`method. If still not successful, it throws a MissingResourceException.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getString](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getString(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Gets a string for the given key from this resource bundle or one of its parents. Calling this method is equivalent to calling`(String) `[getObject](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getObject(kotlin.String))`(key)`.
| | [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>! | [getStringArray](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getStringArray(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Gets a string array for the given key from this resource bundle or one of its parents. Calling this method is equivalent to calling`(String[]) `[getObject](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getObject(kotlin.String))`(key)`.
| | [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>! | [keySet](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#keySet())`()`
Returns a`Set`of all keys contained in this`ResourceBundle`and its parent bundles.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setParent](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#setParent(java.util.ResourceBundle))`(`parent:` `[ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)!`)`
Sets the parent bundle of this bundle. The parent bundle is searched by[getObject](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getObject(kotlin.String))when this bundle does not contain a particular resource.
| || | Inherited properties || |---|---| | From class[ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle) |--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [ResourceBundle](https://developer.android.com/reference/kotlin/java/util/ResourceBundle)! | [parent](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#parent:java.util.ResourceBundle)
The parent bundle of this bundle. The parent bundle is searched by[getObject](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#getObject(kotlin.String))when this bundle does not contain a particular resource.
| || ## Public constructors ### PropertyResourceBundle Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` PropertyResourceBundle(stream: InputStream!) ``` Creates a property resource bundle from an[InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#). This constructor reads the property file in UTF-8 by default. If a[java.nio.charset.MalformedInputException](https://developer.android.com/reference/kotlin/java/nio/charset/MalformedInputException.html#)or an[java.nio.charset.UnmappableCharacterException](https://developer.android.com/reference/kotlin/java/nio/charset/UnmappableCharacterException.html#)occurs on reading the input stream, then the PropertyResourceBundle instance resets to the state before the exception, re-reads the input stream in`ISO-8859-1`and continues reading. If the system property`java.util.PropertyResourceBundle.encoding`is set to either "ISO-8859-1" or "UTF-8", the input stream is solely read in that encoding, and throws the exception if it encounters an invalid sequence. Other encoding values are ignored for this system property. The system property is read and evaluated when initializing this class. Changing or removing the property has no effect after the initialization. | Parameters || |----------|-------------------------------------------------------------------------------------------------------------------------------------------------------| | `stream` | [InputStream](https://developer.android.com/reference/kotlin/java/io/InputStream.html#)!:an InputStream that represents a property file to read from. | | Exceptions || |-------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| | `java.io.IOException` | if an I/O error occurs | | `java.lang.NullPointerException` | if`stream`is null | | `java.lang.IllegalArgumentException` | if`stream`contains a malformed Unicode escape sequence. | | `java.nio.charset.MalformedInputException` | if the system property`java.util.PropertyResourceBundle.encoding`is set to "UTF-8" and`stream`contains an invalid UTF-8 byte sequence. | | `java.nio.charset.UnmappableCharacterException` | if the system property`java.util.PropertyResourceBundle.encoding`is set to "UTF-8" and`stream`contains an unmappable UTF-8 byte sequence. | ### PropertyResourceBundle Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` PropertyResourceBundle(reader: Reader!) ``` Creates a property resource bundle from a[Reader](https://developer.android.com/reference/kotlin/java/io/Reader.html#). Unlike the constructor[PropertyResourceBundle(InputStream)](https://developer.android.com/reference/kotlin/java/util/PropertyResourceBundle#PropertyResourceBundle(java.io.InputStream)), there is no limitation as to the encoding of the input property file. | Parameters || |----------|---------------------------------------------------------------------------------------------------------------------------------------| | `reader` | [Reader](https://developer.android.com/reference/kotlin/java/io/Reader.html#)!:a Reader that represents a property file to read from. | | Exceptions || |--------------------------------------|--------------------------------------------------------------| | `java.io.IOException` | if an I/O error occurs | | `java.lang.NullPointerException` | if`reader`is null | | `java.lang.IllegalArgumentException` | if a malformed Unicode escape sequence appears from`reader`. | ## Public methods ### getKeys Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun getKeys(): Enumeration! ``` Returns an`Enumeration`of the keys contained in this`ResourceBundle`and its parent bundles. | Return || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| | [Enumeration](https://developer.android.com/reference/kotlin/java/util/Enumeration)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>! | an`Enumeration`of the keys contained in this`ResourceBundle`and its parent bundles. | **See Also** - [#keySet()](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#keySet()) ### handleGetObject Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun handleGetObject(key: String!): Any! ``` | Parameters || |-------|------------------------------------------------------------------------------------------------------------------| | `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:the key for the desired object | | Return || |-----------------------------------------------------------------------------|---------------------------------------| | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | the object for the given key, or null | ## Protected methods ### handleKeySet Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` protected open fun handleKeySet(): MutableSet! ``` Returns a`Set`of the keys contained*only* in this`ResourceBundle`. | Return || |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| | [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!>! | a`Set`of the keys contained only in this`ResourceBundle` | **See Also** - [#keySet()](https://developer.android.com/reference/kotlin/java/util/ResourceBundle#keySet())