Java resource bundle: Difference between revisions

Revision as of 18:23, 20 April 2009

Latest revision as of 21:06, 9 August 2025

(42 intermediate revisions by 26 users not shown)

Line 1:

{{Short description|Computer language data file}}

A resource bundle is a [[Java]] [[.properties file]] that contains locale-specific data<ref>[http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/]</ref>. It is a way of internationalising a Java application by making the code locale-independent. Resource bundles are easy to localise and they mainly contain strings.

{{also|Resource (Java)}}

A resource bundle is a [[Java (software platform)|Java]] [[.properties]] file that contains [[Locale (computer software)|locale]]-specific data.<ref>{{Cite web|first=John|last=O'Conner|archive-date=2007-01-03|title=Java Internationalization: Localization with ResourceBundles|url=http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/|archive-url=https://web.archive.org/web/20070103035343/http://java.sun.com/developer/technicalArticles/Intl/ResourceBundles/|access-date=2020-11-16|website=Sun Developer Network}}</ref> It is a way of internationalising a Java application by making the code locale-independent.

== Naming a resource bundle ==

Resource bundles have a naming convention to identify them when they deal with different languages. The file name is followed by an underscore and a two-letter language code ([[ISO 639-2]] code) that specifies the language that the resource bundle deals with. So, for example, an application that supports Spanish and French can have these resource bundles:

resbund_es.properties (this one includes data for version in Spanish)

resbund_fr.properties (this other one includes data for version in French)

This can also be followed by another underscore and a two-letter country code([[ISO 3166-1]]). In this case, an application that supports British and US English will have the following files:

resbund_en_UK.properties

resbund_en_US.properties

== Content of resource bundles ==

Resource bundles are essentially text files. The most common type of content in a resource bundle is a list of strings. Each string has a “key” to identify it, which is the same in all the different resource bundles. When writing the code for the application, only the key is mentioned (this is why we say that the code is locale-independent). Using the methods provided in the Java API for the ResourceBundle class<ref>[http://java.sun.com/j2se/1.5.0/docs/api/ Java API ResourceBundle Class]</ref> , we can access the string (i.e. the "value") associated with the key. Depending on which locale the application is handling, it will call the adequate resource bundle at runtime<ref>Esselink, B. ''A Practical Guide to Software Localisation'', John Benjamins Publishing (1998).</ref>.

For instance, our resource bundle for the UK English locale can contain “firstKey = Localisation” and our US English one can contain “firstKey = Localization”. We will refer only to “firstKey” in the code and, according to the current locale settings, the application will use either “Localization” or “Localisation”.

== Benefits of using resource bundles ==

Extracting locale-sensitive objects such as strings from the code (as opposed to [[hard-coding]] them) means that the application can handle multiple locales without having to write different code for each locale. It also means that translators can deal with just the translatable text and not the programming code. Therefore, using resource bundles improves the [[internationalisation]] and the [[Internationalization and localization|localisation]] process of a software product.

== NamingTranslating a resource bundle ==

Some [[CATComputer-assisted toolstranslation|CAT]] tools like [[OmegaT]] and, OmegaT+ ,<ref>[httphttps://omegatplus.sourceforge.net/ OmegaT+]</ref> [[Swordfish Translation Editor|Swordfish]] or Sun's [[Open language tools]] can specifically handle resource bundles. In addition to these, translators can use any [[text editor]] to create new resource bundles or to modify existing ones.

== ContentTools ofto create resource bundles ==

Extracting locale-sensitive objects such as strings from the code (as opposed to [[hard-coding]] them) means that the application can handle multiple locales without having to write different code for each locale. It also means that translators can deal with just the translatable text and not the programming code. Therefore, using resource bundles improves the [[internationalisation]] and the [[localisation]] process of a software product.

The [http://www.tmasoft.de/MessageCompiler/index.html Message Compiler] <ref>[http://www.tmasoft.de/MessageCompiler/index.html Message Compiler]</ref> is a tool to generate resource bundle files from a single source file containing localized text definitions in different languages. The Message Compiler creates also constant definitions for the keys used to access the localized texts with the methods of the [[Java (programming language)|Java]] class [http://docs.oracle.com/javase/6/docs/api/java/util/ResourceBundle.html?is-external=true ResourceBundle (6)], [https://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html ResourceBundle (7)] and [[HTML]] documentation pages for each language.

== NotesSee also ==

*[[Bundled software]]

== References ==

== Translating resource bundles ==

<references/>

{{DEFAULTSORT:Java Resource Bundle}}

[[Category:Java (programming language)]]

Some [[CAT tools]] like [[OmegaT]] and OmegaT+ <ref>[http://omegatplus.sourceforge.net/ OmegaT+]</ref> can specifically handle resource bundles. In addition to these, translators can use any text editor to create new resource bundles or to modify existing ones.

== Notes ==

<references/>