What is the ResourceBundle class?

The java.util.ResourceBundle class is used to store texts and components that are locale sensitive.
ResourceBundle has the subclasses PropertiesResourceBundle and ListResourceBundle.

public abstract class ResourceBundle extends Object

Resource bundles contain locale-specific objects. When your program needs a locale-specific resource, a String for example, your program can load it from the resource bundle that is appropriate for the current user’s locale. In this way, you can write program code that is largely independent of the user’s locale isolating most, if not all, of the locale-specific information in resource bundles.

It allows you to write programs that can:

– be easily localized, or translated, into different languages
– handle multiple locales at once
– be easily modified later to support even more locales

Resource bundles belong to families whose members share a common base name, but whose names also have additional components that identify their locales. For example, the base name of a family of resource bundles might be “MyResources”. The family should have a default resource bundle which simply has the same name as its family – “MyResources” – and will be used as the bundle of last resort if a specific locale is not supported. The family can then provide as many locale-specific members as needed, for example a German one named “MyResources_de”.

Each resource bundle in a family contains the same items, but the items have been translated for the locale represented by that resource bundle. For example, both “MyResources” and “MyResources_de” may have a String that’s used on a button for canceling operations. In “MyResources” the String may contain “Cancel” and in “MyResources_de” it may contain “Abbrechen”.

If there are different resources for different countries, you can make specializations: for example, “MyResources_de_CH” contains objects for the German language (de) in Switzerland (CH). If you want to only modify some of the resources in the specialization, you can do so.

When your program needs a locale-specific object, it loads the ResourceBundle class using the getBundle method:

ResourceBundle myResources =
      ResourceBundle.getBundle("MyResources", currentLocale);

Resource bundles contain key/value pairs. The keys uniquely identify a locale-specific object in the bundle. Here’s an example of a ListResourceBundle that contains two key/value pairs:

public class MyResources extends ListResourceBundle {
     protected Object[][] getContents() {
         return new Object[][] {
             // LOCALIZE THE SECOND STRING OF EACH ARRAY (e.g., "OK")
             {"OkKey", "OKay"},
             {"CancelKey", "Cancel"},
             // END OF MATERIAL TO LOCALIZE
        };
     }
 }

Keys are always Strings. The values can be any type of object.

You retrieve an object from resource bundle using the appropriate getter method. Because “OkKey” and “CancelKey” are both strings, you would use getString to retrieve them:

Button buttonOk = new Button(myResources.getString("OkKey"));
Button buttonCancel = new Button(myResources.getString("CancelKey"));