151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 22c87ad3a45cecf9e344487cad1abfdebe79f2c7cNarayan Kamath * Copyright (C) 2014 The Android Open Source Project 37ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (C) Copyright Taligent, Inc. 1996, 1997 - All Rights Reserved 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (C) Copyright IBM Corp. 1996 - 1999 - All Rights Reserved 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The original version of this source code and documentation 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is copyrighted and owned by Taligent, Inc., a wholly-owned 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * subsidiary of IBM. These materials are provided under terms 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of a License Agreement between Taligent and Sun. This technology 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is protected by multiple US and International patents. 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This notice and attribution to Taligent may not be removed. 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Taligent is a registered trademark of Taligent, Inc. 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.util; 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.IOException; 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.InputStream; 46ac8051d6632fe2e0d2c50b0d519e21fa7030f2a0Narayan Kamathimport java.io.InputStreamReader; 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.ref.ReferenceQueue; 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.ref.SoftReference; 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.ref.WeakReference; 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.net.JarURLConnection; 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.net.URL; 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.net.URLConnection; 53ac8051d6632fe2e0d2c50b0d519e21fa7030f2a0Narayan Kamathimport java.nio.charset.StandardCharsets; 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.AccessController; 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.PrivilegedAction; 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.PrivilegedActionException; 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.PrivilegedExceptionAction; 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.concurrent.ConcurrentHashMap; 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.concurrent.ConcurrentMap; 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.jar.JarEntry; 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 627ff253db3117067931e9f249762812de7f3bf694Tobias Thiererimport dalvik.system.VMStack; 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.reflect.CallerSensitive; 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.util.locale.BaseLocale; 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.util.locale.LocaleObjectCache; 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6892924f23a03635bb194b6481c4a950e6414ca4e4Neil Fuller// Android-changed: Removed reference to ResourceBundleControlProvider. 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Resource bundles contain locale-specific objects. When your program needs a 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale-specific resource, a <code>String</code> for example, your program can 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * load it from the resource bundle that is appropriate for the current user's 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale. In this way, you can write program code that is largely independent 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of the user's locale isolating most, if not all, of the locale-specific 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * information in resource bundles. 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This allows you to write programs that can: 807ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <UL> 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <LI> be easily localized, or translated, into different languages 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <LI> handle multiple locales at once 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <LI> be easily modified later to support even more locales 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </UL> 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Resource bundles belong to families whose members share a common base 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name, but whose names also have additional components that identify 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * their locales. For example, the base name of a family of resource 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundles might be "MyResources". The family should have a default 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle which simply has the same name as its family - 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "MyResources" - and will be used as the bundle of last resort if a 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specific locale is not supported. The family can then provide as 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * many locale-specific members as needed, for example a German one 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * named "MyResources_de". 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Each resource bundle in a family contains the same items, but the items have 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * been translated for the locale represented by that resource bundle. 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * For example, both "MyResources" and "MyResources_de" may have a 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>String</code> that's used on a button for canceling operations. 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In "MyResources" the <code>String</code> may contain "Cancel" and in 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "MyResources_de" it may contain "Abbrechen". 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If there are different resources for different countries, you 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * can make specializations: for example, "MyResources_de_CH" contains objects for 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the German language (de) in Switzerland (CH). If you want to only 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * modify some of the resources 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in the specialization, you can do so. 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * When your program needs a locale-specific object, it loads 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <code>ResourceBundle</code> class using the 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #getBundle(java.lang.String, java.util.Locale) getBundle} 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method: 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle myResources = 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle.getBundle("MyResources", currentLocale); 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Resource bundles contain key/value pairs. The keys uniquely 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * identify a locale-specific object in the bundle. Here's an 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * example of a <code>ListResourceBundle</code> that contains 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * two key/value pairs: 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public class MyResources extends ListResourceBundle { 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * protected Object[][] getContents() { 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return new Object[][] { 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // LOCALIZE THE SECOND STRING OF EACH ARRAY (e.g., "OK") 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {"OkKey", "OK"}, 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {"CancelKey", "Cancel"}, 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // END OF MATERIAL TO LOCALIZE 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * }; 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Keys are always <code>String</code>s. 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In this example, the keys are "OkKey" and "CancelKey". 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In the above example, the values 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are also <code>String</code>s--"OK" and "Cancel"--but 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * they don't have to be. The values can be any type of object. 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You retrieve an object from resource bundle using the appropriate 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getter method. Because "OkKey" and "CancelKey" 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are both strings, you would use <code>getString</code> to retrieve them: 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 15451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * button1 = new Button(myResources.getString("OkKey")); 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * button2 = new Button(myResources.getString("CancelKey")); 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 15851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 15951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The getter methods all require the key as an argument and return 16051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the object if found. If the object is not found, the getter method 16151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * throws a <code>MissingResourceException</code>. 16251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 16351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 16451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Besides <code>getString</code>, <code>ResourceBundle</code> also provides 16551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a method for getting string arrays, <code>getStringArray</code>, 16651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * as well as a generic <code>getObject</code> method for any other 16751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * type of object. When using <code>getObject</code>, you'll 16851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * have to cast the result to the appropriate type. For example: 16951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 17051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 17151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * int[] myIntegers = (int[]) myResources.getObject("intList"); 17251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 17351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 17451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 17551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 17651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The Java Platform provides two subclasses of <code>ResourceBundle</code>, 17751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ListResourceBundle</code> and <code>PropertyResourceBundle</code>, 17851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that provide a fairly simple way to create resources. 17951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * As you saw briefly in a previous example, <code>ListResourceBundle</code> 18051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * manages its resource as a list of key/value pairs. 18151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>PropertyResourceBundle</code> uses a properties file to manage 18251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * its resources. 18351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 18451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 18551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If <code>ListResourceBundle</code> or <code>PropertyResourceBundle</code> 18651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * do not suit your needs, you can write your own <code>ResourceBundle</code> 18751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * subclass. Your subclasses must override two methods: <code>handleGetObject</code> 18851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and <code>getKeys()</code>. 18951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1907ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <p> 1917ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * The implementation of a {@code ResourceBundle} subclass must be thread-safe 1927ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * if it's simultaneously used by multiple threads. The default implementations 1937ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * of the non-abstract methods in this class, and the methods in the direct 1947ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * known concrete subclasses {@code ListResourceBundle} and 1957ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * {@code PropertyResourceBundle} are thread-safe. 1967ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * 1977ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <h3>ResourceBundle.Control</h3> 19851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 19951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The {@link ResourceBundle.Control} class provides information necessary 20051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to perform the bundle loading process by the <code>getBundle</code> 20151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * factory methods that take a <code>ResourceBundle.Control</code> 20251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instance. You can implement your own subclass in order to enable 20351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * non-standard resource bundle formats, change the search strategy, or 20451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * define caching parameters. Refer to the descriptions of the class and the 20551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #getBundle(String, Locale, ClassLoader, Control) getBundle} 20651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * factory method for details. 20751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2087ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <h3>Cache Management</h3> 20951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 21051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Resource bundle instances created by the <code>getBundle</code> factory 21151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * methods are cached by default, and the factory methods return the same 21251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle instance multiple times if it has been 21351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cached. <code>getBundle</code> clients may clear the cache, manage the 21451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * lifetime of cached resource bundle instances using time-to-live values, 21551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or specify not to cache resource bundle instances. Refer to the 21651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * descriptions of the {@linkplain #getBundle(String, Locale, ClassLoader, 21751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control) <code>getBundle</code> factory method}, {@link 21851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #clearCache(ClassLoader) clearCache}, {@link 21951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#getTimeToLive(String, Locale) 22051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle.Control.getTimeToLive}, and {@link 22151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#needsReload(String, Locale, String, ClassLoader, ResourceBundle, 22251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * long) ResourceBundle.Control.needsReload} for details. 22351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2247ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <h3>Example</h3> 22551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The following is a very simple example of a <code>ResourceBundle</code> 22751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * subclass, <code>MyResources</code>, that manages two resources (for a larger number of 22851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resources you would probably use a <code>Map</code>). 22951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Notice that you don't need to supply a value if 23051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a "parent-level" <code>ResourceBundle</code> handles the same 23151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * key with the same value (as for the okKey below). 23251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 23351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 23451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // default (English language, United States) 23551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public class MyResources extends ResourceBundle { 23651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public Object handleGetObject(String key) { 23751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (key.equals("okKey")) return "Ok"; 23851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (key.equals("cancelKey")) return "Cancel"; 23951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return null; 24051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 24151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 24251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public Enumeration<String> getKeys() { 24351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return Collections.enumeration(keySet()); 24451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 24551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 24651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // Overrides handleKeySet() so that the getKeys() implementation 24751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // can rely on the keySet() value. 24851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * protected Set<String> handleKeySet() { 24951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return new HashSet<String>(Arrays.asList("okKey", "cancelKey")); 25051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 25151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 25251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 25351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // German language 25451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public class MyResources_de extends MyResources { 25551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public Object handleGetObject(String key) { 25651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // don't need okKey, since parent level handles it. 25751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (key.equals("cancelKey")) return "Abbrechen"; 25851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return null; 25951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 26051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * protected Set<String> handleKeySet() { 26251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return new HashSet<String>(Arrays.asList("cancelKey")); 26351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 26451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 26551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 26651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 26751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You do not have to restrict yourself to using a single family of 26851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code>s. For example, you could have a set of bundles for 26951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * exception messages, <code>ExceptionResources</code> 27051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<code>ExceptionResources_fr</code>, <code>ExceptionResources_de</code>, ...), 27151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and one for widgets, <code>WidgetResource</code> (<code>WidgetResources_fr</code>, 27251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>WidgetResources_de</code>, ...); breaking up the resources however you like. 27351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 27451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see ListResourceBundle 27551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see PropertyResourceBundle 27651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MissingResourceException 27751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since JDK1.1 27851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 27951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic abstract class ResourceBundle { 28051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** initial size of the bundle cache */ 28251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final int INITIAL_CACHE_SIZE = 32; 28351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** constant indicating that no resource bundle exists */ 28551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final ResourceBundle NONEXISTENT_BUNDLE = new ResourceBundle() { 28651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Enumeration<String> getKeys() { return null; } 28751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected Object handleGetObject(String key) { return null; } 28851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String toString() { return "NONEXISTENT_BUNDLE"; } 28951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }; 29051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 29151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 29251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 29351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The cache is a map from cache keys (with bundle base name, locale, and 29451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * class loader) to either a resource bundle or NONEXISTENT_BUNDLE wrapped by a 29551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * BundleReference. 29651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 29751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The cache is a ConcurrentMap, allowing the cache to be searched 29851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * concurrently by multiple threads. This will also allow the cache keys 29951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to be reclaimed along with the ClassLoaders they reference. 30051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 30151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This variable would be better named "cache", but we keep the old 30251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name for compatibility with some workarounds for bug 4212439. 30351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 30451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final ConcurrentMap<CacheKey, BundleReference> cacheList 30551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new ConcurrentHashMap<>(INITIAL_CACHE_SIZE); 30651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 30751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 30851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Queue for reference objects referring to class loaders or bundles. 30951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 3107ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static final ReferenceQueue<Object> referenceQueue = new ReferenceQueue<>(); 3117ff253db3117067931e9f249762812de7f3bf694Tobias Thierer 3127ff253db3117067931e9f249762812de7f3bf694Tobias Thierer /** 3137ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * Returns the base name of this bundle, if known, or {@code null} if unknown. 3147ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * 3157ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * If not null, then this is the value of the {@code baseName} parameter 3167ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * that was passed to the {@code ResourceBundle.getBundle(...)} method 3177ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * when the resource bundle was loaded. 3187ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * 3197ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * @return The base name of the resource bundle, as provided to and expected 3207ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * by the {@code ResourceBundle.getBundle(...)} methods. 3217ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * 3227ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * @see #getBundle(java.lang.String, java.util.Locale, java.lang.ClassLoader) 3237ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * 3247ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * @since 1.8 3257ff253db3117067931e9f249762812de7f3bf694Tobias Thierer */ 3267ff253db3117067931e9f249762812de7f3bf694Tobias Thierer public String getBaseBundleName() { 3277ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return name; 3287ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 32951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 33051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 33151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The parent bundle of this bundle. 33251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The parent bundle is searched by {@link #getObject getObject} 33351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * when this bundle does not contain a particular resource. 33451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 33551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected ResourceBundle parent = null; 33651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 33751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 33851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The locale for this bundle. 33951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 34051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Locale locale = null; 34151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 34251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 34351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The base bundle name for this bundle. 34451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 34551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private String name; 34651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 34751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 34851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The flag indicating this bundle has expired in the cache. 34951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 35051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private volatile boolean expired; 35151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 35251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 35351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The back link to the cache key. null if this bundle isn't in 35451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the cache (yet) or has expired. 35551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 35651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private volatile CacheKey cacheKey; 35751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 35851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 35951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A Set of the keys contained only in this ResourceBundle. 36051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 36151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private volatile Set<String> keySet; 36251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3639eca269fb2932fb9fd99b6e898600e7a21ade0e0Tobias Thierer // Android-changed: Removed use of ResourceBundleControlProvider. 3649eca269fb2932fb9fd99b6e898600e7a21ade0e0Tobias Thierer /* 3657ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static final List<ResourceBundleControlProvider> providers; 3667ff253db3117067931e9f249762812de7f3bf694Tobias Thierer 3677ff253db3117067931e9f249762812de7f3bf694Tobias Thierer static { 3687ff253db3117067931e9f249762812de7f3bf694Tobias Thierer List<ResourceBundleControlProvider> list = null; 3697ff253db3117067931e9f249762812de7f3bf694Tobias Thierer ServiceLoader<ResourceBundleControlProvider> serviceLoaders 3707ff253db3117067931e9f249762812de7f3bf694Tobias Thierer = ServiceLoader.loadInstalled(ResourceBundleControlProvider.class); 3717ff253db3117067931e9f249762812de7f3bf694Tobias Thierer for (ResourceBundleControlProvider provider : serviceLoaders) { 3727ff253db3117067931e9f249762812de7f3bf694Tobias Thierer if (list == null) { 3737ff253db3117067931e9f249762812de7f3bf694Tobias Thierer list = new ArrayList<>(); 3747ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 3757ff253db3117067931e9f249762812de7f3bf694Tobias Thierer list.add(provider); 3767ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 3777ff253db3117067931e9f249762812de7f3bf694Tobias Thierer providers = list; 3787ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 37992924f23a03635bb194b6481c4a950e6414ca4e4Neil Fuller */ 3807ff253db3117067931e9f249762812de7f3bf694Tobias Thierer 38151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 38251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Sole constructor. (For invocation by subclass constructors, typically 38351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implicit.) 38451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 38551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public ResourceBundle() { 38651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 38851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 38951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets a string for the given key from this resource bundle or one of its parents. 39051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Calling this method is equivalent to calling 39151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 39251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>(String) {@link #getObject(java.lang.String) getObject}(key)</code>. 39351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 39451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 39551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key the key for the desired string 39651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException if <code>key</code> is <code>null</code> 39751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException if no object for the given key can be found 39851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception ClassCastException if the object found for the given key is not a string 39951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the string for the given key 40051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 40151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String getString(String key) { 40251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (String) getObject(key); 40351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 40451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 40551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 40651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets a string array for the given key from this resource bundle or one of its parents. 40751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Calling this method is equivalent to calling 40851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 40951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>(String[]) {@link #getObject(java.lang.String) getObject}(key)</code>. 41051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 41151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 41251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key the key for the desired string array 41351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException if <code>key</code> is <code>null</code> 41451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException if no object for the given key can be found 41551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception ClassCastException if the object found for the given key is not a string array 41651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the string array for the given key 41751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 41851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String[] getStringArray(String key) { 41951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (String[]) getObject(key); 42051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 42151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 42251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 42351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets an object for the given key from this resource bundle or one of its parents. 42451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This method first tries to obtain the object from this resource bundle using 42551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #handleGetObject(java.lang.String) handleGetObject}. 42651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If not successful, and the parent resource bundle is not null, 42751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it calls the parent's <code>getObject</code> method. 42851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If still not successful, it throws a MissingResourceException. 42951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 43051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key the key for the desired object 43151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException if <code>key</code> is <code>null</code> 43251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException if no object for the given key can be found 43351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the object for the given key 43451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 43551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final Object getObject(String key) { 43651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Object obj = handleGetObject(key); 43751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (obj == null) { 43851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (parent != null) { 43951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski obj = parent.getObject(key); 44051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 4417ff253db3117067931e9f249762812de7f3bf694Tobias Thierer if (obj == null) { 44251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new MissingResourceException("Can't find resource for bundle " 44351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski +this.getClass().getName() 44451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski +", key "+key, 44551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.getClass().getName(), 44651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski key); 4477ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 44851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 44951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return obj; 45051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 45151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 45251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 45351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the locale of this resource bundle. This method can be used after a 45451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * call to getBundle() to determine whether the resource bundle returned really 45551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * corresponds to the requested locale or is a fallback. 45651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 45751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the locale of this resource bundle 45851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 45951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Locale getLocale() { 46051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return locale; 46151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 46251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 46351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* 46451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Automatic determination of the ClassLoader to be used to load 46551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resources on behalf of the client. 46651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 4679c853c5b9ebbb0ef60a013ae10ee411d70dfa832Piotr Jastrzebski private static ClassLoader getLoader(ClassLoader cl) { 4687ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: On Android, this method takes a ClassLoader argument: 4697ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Callers call {@code getLoader(VMStack.getCallingClassLoader())} 4707ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // instead of {@code getLoader(Reflection.getCallerClass())}. 4717ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // ClassLoader cl = caller == null ? null : caller.getClassLoader(); 47251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cl == null) { 47351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // When the caller's loader is the boot class loader, cl is null 47451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // here. In that case, ClassLoader.getSystemClassLoader() may 47551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // return the same class loader that the application is 47651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // using. We therefore use a wrapper ClassLoader to create a 47751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // separate scope for bundles loaded on behalf of the Java 47851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // runtime so that these bundles cannot be returned from the 47951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // cache to the application (5048280). 48051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cl = RBClassLoader.INSTANCE; 48151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 48251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cl; 48351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 48451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 48551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 48651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A wrapper of ClassLoader.getSystemClassLoader(). 48751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 48851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static class RBClassLoader extends ClassLoader { 48951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final RBClassLoader INSTANCE = AccessController.doPrivileged( 49051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedAction<RBClassLoader>() { 49151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public RBClassLoader run() { 49251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return new RBClassLoader(); 49351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 49451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }); 49551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final ClassLoader loader = ClassLoader.getSystemClassLoader(); 49651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 49751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private RBClassLoader() { 49851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 49951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Class<?> loadClass(String name) throws ClassNotFoundException { 50051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader != null) { 50151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return loader.loadClass(name); 50251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 50351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return Class.forName(name); 50451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 50551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public URL getResource(String name) { 50651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader != null) { 50751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return loader.getResource(name); 50851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 50951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ClassLoader.getSystemResource(name); 51051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 51151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public InputStream getResourceAsStream(String name) { 51251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader != null) { 51351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return loader.getResourceAsStream(name); 51451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 51551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ClassLoader.getSystemResourceAsStream(name); 51651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 51751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 51851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 51951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 52051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Sets the parent bundle of this bundle. 52151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The parent bundle is searched by {@link #getObject getObject} 52251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * when this bundle does not contain a particular resource. 52351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 52451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param parent this bundle's parent bundle. 52551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 52651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected void setParent(ResourceBundle parent) { 52751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski assert parent != NONEXISTENT_BUNDLE; 52851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.parent = parent; 52951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 53051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 53151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 53251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Key used for cached resource bundles. The key checks the base 53351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name, the locale, and the class loader to determine if the 53451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource is a match to the requested one. The loader may be 53551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * null, but the base name and the locale must have a non-null 53651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * value. 53751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 5387ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static class CacheKey implements Cloneable { 53951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // These three are the actual keys for lookup in Map. 54051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private String name; 54151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Locale locale; 54251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private LoaderReference loaderRef; 54351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 54451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // bundle format which is necessary for calling 54551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Control.needsReload(). 54651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private String format; 54751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 54851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // These time values are in CacheKey so that NONEXISTENT_BUNDLE 54951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // doesn't need to be cloned for caching. 55051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 55151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // The time when the bundle has been loaded 55251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private volatile long loadTime; 55351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 55451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // The time when the bundle expires in the cache, or either 55551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Control.TTL_DONT_CACHE or Control.TTL_NO_EXPIRATION_CONTROL. 55651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private volatile long expirationTime; 55751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 55851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Placeholder for an error report by a Throwable 55951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Throwable cause; 56051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 56151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Hash code value cache to avoid recalculating the hash code 56251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // of this instance. 56351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private int hashCodeCache; 56451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 56551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey(String baseName, Locale locale, ClassLoader loader) { 56651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.name = baseName; 56751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.locale = locale; 56851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader == null) { 56951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.loaderRef = null; 57051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 57151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski loaderRef = new LoaderReference(loader, referenceQueue, this); 57251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 57351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski calculateHashCode(); 57451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 57551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 57651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String getName() { 57751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 57851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 57951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 58051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey setName(String baseName) { 58151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!this.name.equals(baseName)) { 58251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.name = baseName; 58351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski calculateHashCode(); 58451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 58551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return this; 58651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 58751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 58851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Locale getLocale() { 58951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return locale; 59051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 59151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 59251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey setLocale(Locale locale) { 59351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!this.locale.equals(locale)) { 59451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.locale = locale; 59551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski calculateHashCode(); 59651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 59751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return this; 59851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 59951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 60051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader getLoader() { 60151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (loaderRef != null) ? loaderRef.get() : null; 60251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 60351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 60451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean equals(Object other) { 60551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (this == other) { 60651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 60751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 60851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 60951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski final CacheKey otherEntry = (CacheKey)other; 61051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski //quick check to see if they are not equal 61151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (hashCodeCache != otherEntry.hashCodeCache) { 61251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 61351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 61451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski //are the names the same? 61551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!name.equals(otherEntry.name)) { 61651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 61751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 61851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // are the locales the same? 61951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!locale.equals(otherEntry.locale)) { 62051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 62151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 62251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski //are refs (both non-null) or (both null)? 62351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loaderRef == null) { 62451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return otherEntry.loaderRef == null; 62551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 62651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader loader = loaderRef.get(); 62751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (otherEntry.loaderRef != null) 62851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // with a null reference we can no longer find 62951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // out which class loader was referenced; so 63051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // treat it as unequal 63151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski && (loader != null) 63251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski && (loader == otherEntry.loaderRef.get()); 6337ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } catch ( NullPointerException | ClassCastException e) { 63451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 63551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 63651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 63751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 63851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int hashCode() { 63951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return hashCodeCache; 64051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 64151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 64251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void calculateHashCode() { 64351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski hashCodeCache = name.hashCode() << 3; 64451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski hashCodeCache ^= locale.hashCode(); 64551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader loader = getLoader(); 64651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader != null) { 64751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski hashCodeCache ^= loader.hashCode(); 64851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 64951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 65051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 65151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Object clone() { 65251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 65351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey clone = (CacheKey) super.clone(); 65451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loaderRef != null) { 65551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski clone.loaderRef = new LoaderReference(loaderRef.get(), 65651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski referenceQueue, clone); 65751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 65851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Clear the reference to a Throwable 65951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski clone.cause = null; 66051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return clone; 66151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (CloneNotSupportedException e) { 66251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski //this should never happen 6637ff253db3117067931e9f249762812de7f3bf694Tobias Thierer throw new InternalError(e); 66451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 66551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 66651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 66751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String getFormat() { 66851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return format; 66951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 67051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 67151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski void setFormat(String format) { 67251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.format = format; 67351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 67451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 67551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void setCause(Throwable cause) { 67651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (this.cause == null) { 67751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.cause = cause; 67851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 67951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Override the cause if the previous one is 68051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // ClassNotFoundException. 68151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (this.cause instanceof ClassNotFoundException) { 68251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.cause = cause; 68351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 68451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 68551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 68651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 68751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Throwable getCause() { 68851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cause; 68951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 69051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 69151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String toString() { 69251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String l = locale.toString(); 69351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (l.length() == 0) { 69451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (locale.getVariant().length() != 0) { 69551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski l = "__" + locale.getVariant(); 69651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 69751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski l = "\"\""; 69851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 69951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 70051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return "CacheKey[" + name + ", lc=" + l + ", ldr=" + getLoader() 70151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski + "(format=" + format + ")]"; 70251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 70351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 70451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 70551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 70651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The common interface to get a CacheKey in LoaderReference and 70751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * BundleReference. 70851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 70951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static interface CacheKeyReference { 71051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public CacheKey getCacheKey(); 71151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 71251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 71351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 71451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * References to class loaders are weak references, so that they can be 71551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * garbage collected when nobody else is using them. The ResourceBundle 71651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * class has no reason to keep class loaders alive. 71751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 7187ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static class LoaderReference extends WeakReference<ClassLoader> 7197ff253db3117067931e9f249762812de7f3bf694Tobias Thierer implements CacheKeyReference { 72051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private CacheKey cacheKey; 72151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7227ff253db3117067931e9f249762812de7f3bf694Tobias Thierer LoaderReference(ClassLoader referent, ReferenceQueue<Object> q, CacheKey key) { 72351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(referent, q); 72451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey = key; 72551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 72651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 72751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public CacheKey getCacheKey() { 72851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cacheKey; 72951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 73051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 73151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 73251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 73351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * References to bundles are soft references so that they can be garbage 73451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * collected when they have no hard references. 73551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 7367ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static class BundleReference extends SoftReference<ResourceBundle> 7377ff253db3117067931e9f249762812de7f3bf694Tobias Thierer implements CacheKeyReference { 73851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private CacheKey cacheKey; 73951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 7407ff253db3117067931e9f249762812de7f3bf694Tobias Thierer BundleReference(ResourceBundle referent, ReferenceQueue<Object> q, CacheKey key) { 74151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(referent, q); 74251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey = key; 74351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 74451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 74551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public CacheKey getCacheKey() { 74651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cacheKey; 74751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 74851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 74951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 75051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 75151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets a resource bundle using the specified base name, the default locale, 75251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and the caller's class loader. Calling this method is equivalent to calling 75351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 75451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>getBundle(baseName, Locale.getDefault(), this.getClass().getClassLoader())</code>, 75551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 75651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that <code>getClassLoader()</code> is run with the security 75751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * privileges of <code>ResourceBundle</code>. 75851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * See {@link #getBundle(String, Locale, ClassLoader) getBundle} 75951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for a complete description of the search and instantiation strategy. 76051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 76151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName the base name of the resource bundle, a fully qualified class name 76251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception java.lang.NullPointerException 76351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> is <code>null</code> 76451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException 76551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no resource bundle for the specified base name can be found 76651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a resource bundle for the given base name and the default locale 76751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 76851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski @CallerSensitive 76951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final ResourceBundle getBundle(String baseName) 77051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 77151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getBundleImpl(baseName, Locale.getDefault(), 7727ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: use of VMStack.getCallingClassLoader() 7739c853c5b9ebbb0ef60a013ae10ee411d70dfa832Piotr Jastrzebski getLoader(VMStack.getCallingClassLoader()), 7747ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // getLoader(Reflection.getCallerClass()), 7757ff253db3117067931e9f249762812de7f3bf694Tobias Thierer getDefaultControl(baseName)); 77651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 77751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 77851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 77951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a resource bundle using the specified base name, the 78051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * default locale and the specified control. Calling this method 78151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is equivalent to calling 78251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 78351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getBundle(baseName, Locale.getDefault(), 78451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this.getClass().getClassLoader(), control), 78551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 78651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that <code>getClassLoader()</code> is run with the security 78751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * privileges of <code>ResourceBundle</code>. See {@link 78851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getBundle(String, Locale, ClassLoader, Control) getBundle} for the 78951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * complete description of the resource bundle loading process with a 79051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code>. 79151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 79251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 79351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully qualified class 79451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name 79551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param control 79651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the control which gives information for the resource bundle 79751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loading process 79851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a resource bundle for the given base name and the default 79951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale 80051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 80151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> or <code>control</code> is 80251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code> 80351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException 80451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no resource bundle for the specified base name can be found 80551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalArgumentException 80651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the given <code>control</code> doesn't perform properly 80751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (e.g., <code>control.getCandidateLocales</code> returns null.) 80851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Note that validation of <code>control</code> is performed as 80951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * needed. 81051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 81151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 81251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski @CallerSensitive 81351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final ResourceBundle getBundle(String baseName, 81451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Control control) { 81551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getBundleImpl(baseName, Locale.getDefault(), 8167ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: use of VMStack.getCallingClassLoader() 8179c853c5b9ebbb0ef60a013ae10ee411d70dfa832Piotr Jastrzebski getLoader(VMStack.getCallingClassLoader()), 8187ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // getLoader(Reflection.getCallerClass()), 81951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski control); 82051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 82151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 82251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 82351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets a resource bundle using the specified base name and locale, 82451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and the caller's class loader. Calling this method is equivalent to calling 82551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote> 82651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>getBundle(baseName, locale, this.getClass().getClassLoader())</code>, 82751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </blockquote> 82851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that <code>getClassLoader()</code> is run with the security 82951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * privileges of <code>ResourceBundle</code>. 83051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * See {@link #getBundle(String, Locale, ClassLoader) getBundle} 83151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for a complete description of the search and instantiation strategy. 83251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 83351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 83451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully qualified class name 83551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 83651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which a resource bundle is desired 83751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 83851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> or <code>locale</code> is <code>null</code> 83951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException 84051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no resource bundle for the specified base name can be found 84151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a resource bundle for the given base name and locale 84251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 84351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski @CallerSensitive 84451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final ResourceBundle getBundle(String baseName, 84551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Locale locale) 84651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 84751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getBundleImpl(baseName, locale, 8487ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: use of VMStack.getCallingClassLoader() 8499c853c5b9ebbb0ef60a013ae10ee411d70dfa832Piotr Jastrzebski getLoader(VMStack.getCallingClassLoader()), 8507ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // getLoader(Reflection.getCallerClass()), 8517ff253db3117067931e9f249762812de7f3bf694Tobias Thierer getDefaultControl(baseName)); 85251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 85351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 85451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 85551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a resource bundle using the specified base name, target 85651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale and control, and the caller's class loader. Calling this 85751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method is equivalent to calling 85851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 85951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getBundle(baseName, targetLocale, this.getClass().getClassLoader(), 86051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * control), 86151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 86251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that <code>getClassLoader()</code> is run with the security 86351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * privileges of <code>ResourceBundle</code>. See {@link 86451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getBundle(String, Locale, ClassLoader, Control) getBundle} for the 86551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * complete description of the resource bundle loading process with a 86651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code>. 86751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 86851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 86951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully qualified 87051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * class name 87151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param targetLocale 87251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which a resource bundle is desired 87351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param control 87451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the control which gives information for the resource 87551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle loading process 87651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a resource bundle for the given base name and a 87751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code> in <code>locales</code> 87851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 87951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code>, <code>locales</code> or 88051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>control</code> is <code>null</code> 88151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException 88251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no resource bundle for the specified base name in any 88351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of the <code>locales</code> can be found. 88451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalArgumentException 88551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the given <code>control</code> doesn't perform properly 88651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (e.g., <code>control.getCandidateLocales</code> returns null.) 88751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Note that validation of <code>control</code> is performed as 88851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * needed. 88951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 89051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 89151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski @CallerSensitive 89251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final ResourceBundle getBundle(String baseName, Locale targetLocale, 89351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Control control) { 89451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getBundleImpl(baseName, targetLocale, 8957ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: use of VMStack.getCallingClassLoader() 8969c853c5b9ebbb0ef60a013ae10ee411d70dfa832Piotr Jastrzebski getLoader(VMStack.getCallingClassLoader()), 8977ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // getLoader(Reflection.getCallerClass()), 89851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski control); 89951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 90051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 90192924f23a03635bb194b6481c4a950e6414ca4e4Neil Fuller // Android-changed: Removed references to ResourceBundleControlProvider. 90251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 90351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets a resource bundle using the specified base name, locale, and class 90451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loader. 90551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9067ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <p>This method behaves the same as calling 90751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #getBundle(String, Locale, ClassLoader, Control)} passing a 90892924f23a03635bb194b6481c4a950e6414ca4e4Neil Fuller * default instance of {@link Control}. 90951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 91051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><code>getBundle</code> uses the base name, the specified locale, and 91151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the default locale (obtained from {@link java.util.Locale#getDefault() 91251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale.getDefault}) to generate a sequence of <a 91351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name="candidates"><em>candidate bundle names</em></a>. If the specified 91451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale's language, script, country, and variant are all empty strings, 91551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * then the base name is the only candidate bundle name. Otherwise, a list 91651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of candidate locales is generated from the attribute values of the 91751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specified locale (language, script, country and variant) and appended to 91851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name. Typically, this will look like the following: 91951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 92051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 92151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language + "_" + script + "_" + country + "_" + variant 92251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language + "_" + script + "_" + country 92351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language + "_" + script 92451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language + "_" + country + "_" + variant 92551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language + "_" + country 92651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language 92751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 92851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 92951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Candidate bundle names where the final component is an empty string 93051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are omitted, along with the underscore. For example, if country is an 93151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * empty string, the second and the fifth candidate bundle names above 93251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * would be omitted. Also, if script is an empty string, the candidate names 93351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * including script are omitted. For example, a locale with language "de" 93451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and variant "JAVA" will produce candidate names with base name 93551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "MyResource" below. 93651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 93751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 93851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_de__JAVA 93951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_de 94051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 94151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 94251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In the case that the variant contains one or more underscores ('_'), a 94351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sequence of bundle names generated by truncating the last underscore and 94451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the part following it is inserted after a candidate bundle name with the 94551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * original variant. For example, for a locale with language "en", script 94651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "Latn, country "US" and variant "WINDOWS_VISTA", and bundle base name 94751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "MyResource", the list of candidate bundle names below is generated: 94851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 94951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 95051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_Latn_US_WINDOWS_VISTA 95151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_Latn_US_WINDOWS 95251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_Latn_US 95351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_Latn 95451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_US_WINDOWS_VISTA 95551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_US_WINDOWS 95651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en_US 95751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResource_en 95851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 95951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 96051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote><b>Note:</b> For some <code>Locale</code>s, the list of 96151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate bundle names contains extra names, or the order of bundle names 96251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is slightly modified. See the description of the default implementation 96351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of {@link Control#getCandidateLocales(String, Locale) 96451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getCandidateLocales} for details.</blockquote> 96551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 96651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><code>getBundle</code> then iterates over the candidate bundle names 96751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to find the first one for which it can <em>instantiate</em> an actual 96851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle. It uses the default controls' {@link Control#getFormats 96951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getFormats} method, which generates two bundle names for each generated 97051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name, the first a class name and the second a properties file name. For 97151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * each candidate bundle name, it attempts to create a resource bundle: 97251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 97351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul><li>First, it attempts to load a class using the generated class name. 97451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If such a class can be found and loaded using the specified class 97551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loader, is assignment compatible with ResourceBundle, is accessible from 97651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle, and can be instantiated, <code>getBundle</code> creates a 97751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * new instance of this class and uses it as the <em>result resource 97851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle</em>. 97951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 98051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Otherwise, <code>getBundle</code> attempts to locate a property 98151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource file using the generated properties file name. It generates a 98251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * path name from the candidate bundle name by replacing all "." characters 98351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with "/" and appending the string ".properties". It attempts to find a 98451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "resource" with this name using {@link 98551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * java.lang.ClassLoader#getResource(java.lang.String) 98651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ClassLoader.getResource}. (Note that a "resource" in the sense of 98751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>getResource</code> has nothing to do with the contents of a 98851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle, it is just a container of data, such as a file.) If it 98951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * finds a "resource", it attempts to create a new {@link 99051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * PropertyResourceBundle} instance from its contents. If successful, this 99151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instance becomes the <em>result resource bundle</em>. </ul> 99251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 99351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This continues until a result resource bundle is instantiated or the 99451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * list of candidate bundle names is exhausted. If no matching resource 99551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle is found, the default control's {@link Control#getFallbackLocale 99651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getFallbackLocale} method is called, which returns the current default 99751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale. A new sequence of candidate locale names is generated using this 99851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale and and searched again, as above. 99951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 100051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If still no result bundle is found, the base name alone is looked up. If 100151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this still fails, a <code>MissingResourceException</code> is thrown. 100251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10037ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <p><a name="parent_chain"> Once a result resource bundle has been found, 10047ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * its <em>parent chain</em> is instantiated</a>. If the result bundle already 100551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has a parent (perhaps because it was returned from a cache) the chain is 100651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * complete. 100751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 100851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Otherwise, <code>getBundle</code> examines the remainder of the 100951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate locale list that was used during the pass that generated the 101051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * result resource bundle. (As before, candidate bundle names where the 101151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * final component is an empty string are omitted.) When it comes to the 101251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * end of the candidate list, it tries the plain bundle name. With each of the 101351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate bundle names it attempts to instantiate a resource bundle (first 101451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * looking for a class and then a properties file, as described above). 101551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 101651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Whenever it succeeds, it calls the previously instantiated resource 101751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle's {@link #setParent(java.util.ResourceBundle) setParent} method 101851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with the new resource bundle. This continues until the list of names 101951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is exhausted or the current bundle already has a non-null parent. 102051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 102151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Once the parent chain is complete, the bundle is returned. 102251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 102351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><b>Note:</b> <code>getBundle</code> caches instantiated resource 102451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundles and might return the same resource bundle instance multiple times. 102551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 102651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><b>Note:</b>The <code>baseName</code> argument should be a fully 102751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * qualified class name. However, for compatibility with earlier versions, 102851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Sun's Java SE Runtime Environments do not verify this, and so it is 102951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * possible to access <code>PropertyResourceBundle</code>s by specifying a 103051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * path name (using "/") instead of a fully qualified class name (using 103151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "."). 103251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10337ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <p><a name="default_behavior_example"> 10347ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <strong>Example:</strong></a> 103551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> 103651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The following class and property files are provided: 103751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 103851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources.class 103951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources.properties 104051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources_fr.properties 104151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources_fr_CH.class 104251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources_fr_CH.properties 104351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources_en.properties 104451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MyResources_es_ES.class 104551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 104651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 104751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The contents of all files are valid (that is, public non-abstract 104851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * subclasses of <code>ResourceBundle</code> for the ".class" files, 104951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * syntactically correct ".properties" files). The default locale is 105051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("en", "GB")</code>. 105151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 105251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Calling <code>getBundle</code> with the locale arguments below will 105351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instantiate resource bundles as follows: 105451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10557ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <table summary="getBundle() locale to resource bundle mapping"> 105651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td>Locale("fr", "CH")</td><td>MyResources_fr_CH.class, parent MyResources_fr.properties, parent MyResources.class</td></tr> 105751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td>Locale("fr", "FR")</td><td>MyResources_fr.properties, parent MyResources.class</td></tr> 105851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td>Locale("de", "DE")</td><td>MyResources_en.properties, parent MyResources.class</td></tr> 105951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td>Locale("en", "US")</td><td>MyResources_en.properties, parent MyResources.class</td></tr> 106051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td>Locale("es", "ES")</td><td>MyResources_es_ES.class, parent MyResources.class</td></tr> 106151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </table> 106251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 106351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The file MyResources_fr_CH.properties is never used because it is 106451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * hidden by the MyResources_fr_CH.class. Likewise, MyResources.properties 106551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is also hidden by MyResources.class. 106651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 106751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName the base name of the resource bundle, a fully qualified class name 106851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale the locale for which a resource bundle is desired 106951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param loader the class loader from which to load the resource bundle 107051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a resource bundle for the given base name and locale 107151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception java.lang.NullPointerException 107251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code>, <code>locale</code>, or <code>loader</code> is <code>null</code> 107351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException 107451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no resource bundle for the specified base name can be found 107551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.2 107651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 107751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static ResourceBundle getBundle(String baseName, Locale locale, 107851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader loader) 107951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 108051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader == null) { 108151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 108251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 10837ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return getBundleImpl(baseName, locale, loader, getDefaultControl(baseName)); 108451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 108551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 108651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 108751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a resource bundle using the specified base name, target 108851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale, class loader and control. Unlike the {@linkplain 108951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getBundle(String, Locale, ClassLoader) <code>getBundle</code> 109051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * factory methods with no <code>control</code> argument}, the given 109151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>control</code> specifies how to locate and instantiate resource 109251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundles. Conceptually, the bundle loading process with the given 109351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>control</code> is performed in the following steps. 109451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 109551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ol> 109651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>This factory method looks up the resource bundle in the cache for 109751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the specified <code>baseName</code>, <code>targetLocale</code> and 109851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>loader</code>. If the requested resource bundle instance is 109951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * found in the cache and the time-to-live periods of the instance and 110051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * all of its parent instances have not expired, the instance is returned 110151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to the caller. Otherwise, this factory method proceeds with the 110251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loading process below.</li> 110351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 110451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>The {@link ResourceBundle.Control#getFormats(String) 110551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * control.getFormats} method is called to get resource bundle formats 110651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to produce bundle or resource names. The strings 110751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"java.class"</code> and <code>"java.properties"</code> 110851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * designate class-based and {@linkplain PropertyResourceBundle 110951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * property}-based resource bundles, respectively. Other strings 111051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * starting with <code>"java."</code> are reserved for future extensions 111151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and must not be used for application-defined formats. Other strings 111251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * designate application-defined formats.</li> 111351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 111451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>The {@link ResourceBundle.Control#getCandidateLocales(String, 111551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale) control.getCandidateLocales} method is called with the target 111651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale to get a list of <em>candidate <code>Locale</code>s</em> for 111751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * which resource bundles are searched.</li> 111851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 111951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>The {@link ResourceBundle.Control#newBundle(String, Locale, 112051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * String, ClassLoader, boolean) control.newBundle} method is called to 112151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instantiate a <code>ResourceBundle</code> for the base bundle name, a 112251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate locale, and a format. (Refer to the note on the cache 112351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * lookup below.) This step is iterated over all combinations of the 112451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate locales and formats until the <code>newBundle</code> method 112551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returns a <code>ResourceBundle</code> instance or the iteration has 112651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * used up all the combinations. For example, if the candidate locales 112751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are <code>Locale("de", "DE")</code>, <code>Locale("de")</code> and 112851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("")</code> and the formats are <code>"java.class"</code> 112951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and <code>"java.properties"</code>, then the following is the 113051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sequence of locale-format combinations to be used to call 113151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>control.newBundle</code>. 113251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 113351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <table style="width: 50%; text-align: left; margin-left: 40px;" 11347ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * border="0" cellpadding="2" cellspacing="2" summary="locale-format combinations for newBundle"> 11357ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <tbody> 113651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 113751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td 11387ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * style="vertical-align: top; text-align: left; font-weight: bold; width: 50%;"><code>Locale</code><br> 113951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </td> 114051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td 11417ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * style="vertical-align: top; text-align: left; font-weight: bold; width: 50%;"><code>format</code><br> 114251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </td> 114351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 114451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 11457ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>Locale("de", "DE")</code><br> 114651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </td> 11477ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>java.class</code><br> 114851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </td> 114951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 115051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 11517ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>Locale("de", "DE")</code></td> 11527ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>java.properties</code><br> 115351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </td> 115451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 115551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 11567ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>Locale("de")</code></td> 11577ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>java.class</code></td> 115851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 115951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 11607ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>Locale("de")</code></td> 11617ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>java.properties</code></td> 116251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 116351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 11647ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>Locale("")</code><br> 116551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </td> 11667ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>java.class</code></td> 116751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 116851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr> 11697ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>Locale("")</code></td> 11707ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <td style="vertical-align: top; width: 50%;"><code>java.properties</code></td> 117151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </tr> 11727ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * </tbody> 117351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </table> 117451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </li> 117551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 117651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>If the previous step has found no resource bundle, proceed to 117751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Step 6. If a bundle has been found that is a base bundle (a bundle 117851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for <code>Locale("")</code>), and the candidate locale list only contained 117951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("")</code>, return the bundle to the caller. If a bundle 118051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has been found that is a base bundle, but the candidate locale list 118151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * contained locales other than Locale(""), put the bundle on hold and 118251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * proceed to Step 6. If a bundle has been found that is not a base 118351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle, proceed to Step 7.</li> 118451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 118551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>The {@link ResourceBundle.Control#getFallbackLocale(String, 118651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale) control.getFallbackLocale} method is called to get a fallback 118751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale (alternative to the current target locale) to try further 118851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * finding a resource bundle. If the method returns a non-null locale, 118951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it becomes the next target locale and the loading process starts over 119051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * from Step 3. Otherwise, if a base bundle was found and put on hold in 119151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a previous Step 5, it is returned to the caller now. Otherwise, a 119251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * MissingResourceException is thrown.</li> 119351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 119451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>At this point, we have found a resource bundle that's not the 119551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * base bundle. If this bundle set its parent during its instantiation, 119651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it is returned to the caller. Otherwise, its <a 119751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="./ResourceBundle.html#parent_chain">parent chain</a> is 119851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instantiated based on the list of candidate locales from which it was 119951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * found. Finally, the bundle is returned to the caller.</li> 120051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ol> 120151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 120251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>During the resource bundle loading process above, this factory 120351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method looks up the cache before calling the {@link 120451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#newBundle(String, Locale, String, ClassLoader, boolean) 120551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * control.newBundle} method. If the time-to-live period of the 120651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle found in the cache has expired, the factory method 120751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * calls the {@link ResourceBundle.Control#needsReload(String, Locale, 120851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * String, ClassLoader, ResourceBundle, long) control.needsReload} 120951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method to determine whether the resource bundle needs to be reloaded. 121051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If reloading is required, the factory method calls 121151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>control.newBundle</code> to reload the resource bundle. If 121251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>control.newBundle</code> returns <code>null</code>, the factory 121351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method puts a dummy resource bundle in the cache as a mark of 121451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * nonexistent resource bundles in order to avoid lookup overhead for 121551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * subsequent requests. Such dummy resource bundles are under the same 121651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * expiration control as specified by <code>control</code>. 121751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 121851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>All resource bundles loaded are cached by default. Refer to 121951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Control#getTimeToLive(String,Locale) 122051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * control.getTimeToLive} for details. 122151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 122251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The following is an example of the bundle loading process with the 122351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * default <code>ResourceBundle.Control</code> implementation. 122451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 122551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Conditions: 122651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 122751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Base bundle name: <code>foo.bar.Messages</code> 122851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Requested <code>Locale</code>: {@link Locale#ITALY}</li> 122951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Default <code>Locale</code>: {@link Locale#FRENCH}</li> 123051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Available resource bundles: 123151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>foo/bar/Messages_fr.properties</code> and 123251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>foo/bar/Messages.properties</code></li> 123351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 123451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 123551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>First, <code>getBundle</code> tries loading a resource bundle in 123651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the following sequence. 123751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 123851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 123951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>class <code>foo.bar.Messages_it_IT</code> 124051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>file <code>foo/bar/Messages_it_IT.properties</code> 124151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>class <code>foo.bar.Messages_it</code></li> 124251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>file <code>foo/bar/Messages_it.properties</code></li> 124351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>class <code>foo.bar.Messages</code></li> 124451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>file <code>foo/bar/Messages.properties</code></li> 124551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 124651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 124751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>At this point, <code>getBundle</code> finds 124851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>foo/bar/Messages.properties</code>, which is put on hold 124951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * because it's the base bundle. <code>getBundle</code> calls {@link 125051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#getFallbackLocale(String, Locale) 125151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * control.getFallbackLocale("foo.bar.Messages", Locale.ITALY)} which 125251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returns <code>Locale.FRENCH</code>. Next, <code>getBundle</code> 125351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * tries loading a bundle in the following sequence. 125451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 125551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 125651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>class <code>foo.bar.Messages_fr</code></li> 125751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>file <code>foo/bar/Messages_fr.properties</code></li> 125851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>class <code>foo.bar.Messages</code></li> 125951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>file <code>foo/bar/Messages.properties</code></li> 126051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 126151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 126251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><code>getBundle</code> finds 126351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>foo/bar/Messages_fr.properties</code> and creates a 126451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> instance. Then, <code>getBundle</code> 12657ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * sets up its parent chain from the list of the candidate locales. Only 126651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>foo/bar/Messages.properties</code> is found in the list and 126751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>getBundle</code> creates a <code>ResourceBundle</code> instance 126851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that becomes the parent of the instance for 126951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>foo/bar/Messages_fr.properties</code>. 127051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 127151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 127251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully qualified 127351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * class name 127451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param targetLocale 127551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which a resource bundle is desired 127651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param loader 127751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the class loader from which to load the resource bundle 127851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param control 127951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the control which gives information for the resource 128051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle loading process 128151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a resource bundle for the given base name and locale 128251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 128351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code>, <code>targetLocale</code>, 128451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>loader</code>, or <code>control</code> is 128551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code> 128651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception MissingResourceException 128751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no resource bundle for the specified base name can be found 128851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalArgumentException 128951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the given <code>control</code> doesn't perform properly 129051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (e.g., <code>control.getCandidateLocales</code> returns null.) 129151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Note that validation of <code>control</code> is performed as 129251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * needed. 129351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 129451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 129551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static ResourceBundle getBundle(String baseName, Locale targetLocale, 129651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader loader, Control control) { 129751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader == null || control == null) { 129851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 129951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 130051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getBundleImpl(baseName, targetLocale, loader, control); 130151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 130251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13037ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static Control getDefaultControl(String baseName) { 130492924f23a03635bb194b6481c4a950e6414ca4e4Neil Fuller // Android-changed: Removed used of ResourceBundleControlProvider. 13057ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return Control.INSTANCE; 13067ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 13077ff253db3117067931e9f249762812de7f3bf694Tobias Thierer 130851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static ResourceBundle getBundleImpl(String baseName, Locale locale, 130951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader loader, Control control) { 131051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (locale == null || control == null) { 131151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 131251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 131351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 131451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // We create a CacheKey here for use by this call. The base 131551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // name and loader will never change during the bundle loading 131651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // process. We have to make sure that the locale is set before 131751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // using it as a cache key. 131851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey cacheKey = new CacheKey(baseName, locale, loader); 131951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle bundle = null; 132051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 132151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Quick lookup of the cache. 132251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski BundleReference bundleRef = cacheList.get(cacheKey); 132351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundleRef != null) { 132451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = bundleRef.get(); 132551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundleRef = null; 132651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 132751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 132851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If this bundle and all of its parents are valid (not expired), 132951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // then return this bundle. If any of the bundles is expired, we 133051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // don't call control.needsReload here but instead drop into the 133151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // complete loading process below. 133251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (isValidBundle(bundle) && hasValidParentChain(bundle)) { 133351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 133451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 133551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 133651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // No valid bundle was found in the cache, so we need to load the 133751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // resource bundle and its parents. 133851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 133951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean isKnownControl = (control == Control.INSTANCE) || 134051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski (control instanceof SingleFormatControl); 134151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<String> formats = control.getFormats(baseName); 134251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!isKnownControl && !checkList(formats)) { 134351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Invalid Control: getFormats"); 134451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 134551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 134651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle baseBundle = null; 134751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (Locale targetLocale = locale; 134851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski targetLocale != null; 134951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski targetLocale = control.getFallbackLocale(baseName, targetLocale)) { 135051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<Locale> candidateLocales = control.getCandidateLocales(baseName, targetLocale); 135151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!isKnownControl && !checkList(candidateLocales)) { 135251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Invalid Control: getCandidateLocales"); 135351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 135451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 135551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = findBundle(cacheKey, candidateLocales, formats, 0, control, baseBundle); 135651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 135751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If the loaded bundle is the base bundle and exactly for the 135851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // requested locale or the only candidate locale, then take the 135951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // bundle as the resulting one. If the loaded bundle is the base 136051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // bundle, it's put on hold until we finish processing all 136151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // fallback locales. 136251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (isValidBundle(bundle)) { 136351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean isBaseBundle = Locale.ROOT.equals(bundle.locale); 136451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!isBaseBundle || bundle.locale.equals(locale) 136551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski || (candidateLocales.size() == 1 136651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski && bundle.locale.equals(candidateLocales.get(0)))) { 136751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski break; 136851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 136951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 137051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If the base bundle has been loaded, keep the reference in 137151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // baseBundle so that we can avoid any redundant loading in case 137251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // the control specify not to cache bundles. 137351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (isBaseBundle && baseBundle == null) { 137451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski baseBundle = bundle; 137551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 137651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 137751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 137851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 137951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle == null) { 138051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseBundle == null) { 138151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throwMissingResourceException(baseName, locale, cacheKey.getCause()); 138251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 138351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = baseBundle; 138451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 138551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 138651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 138751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 138851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 138951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 139051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Checks if the given <code>List</code> is not null, not empty, 139151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not having null in its elements. 139251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13937ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static boolean checkList(List<?> a) { 13947ff253db3117067931e9f249762812de7f3bf694Tobias Thierer boolean valid = (a != null && !a.isEmpty()); 139551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (valid) { 139651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int size = a.size(); 139751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; valid && i < size; i++) { 139851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski valid = (a.get(i) != null); 139951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 140051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 140151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return valid; 140251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 140351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14047ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static ResourceBundle findBundle(CacheKey cacheKey, 14057ff253db3117067931e9f249762812de7f3bf694Tobias Thierer List<Locale> candidateLocales, 14067ff253db3117067931e9f249762812de7f3bf694Tobias Thierer List<String> formats, 14077ff253db3117067931e9f249762812de7f3bf694Tobias Thierer int index, 14087ff253db3117067931e9f249762812de7f3bf694Tobias Thierer Control control, 14097ff253db3117067931e9f249762812de7f3bf694Tobias Thierer ResourceBundle baseBundle) { 141051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Locale targetLocale = candidateLocales.get(index); 141151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle parent = null; 141251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (index != candidateLocales.size() - 1) { 141351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski parent = findBundle(cacheKey, candidateLocales, formats, index + 1, 141451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski control, baseBundle); 141551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (baseBundle != null && Locale.ROOT.equals(targetLocale)) { 141651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return baseBundle; 141751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 141851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 141951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Before we do the real loading work, see whether we need to 142051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // do some housekeeping: If references to class loaders or 142151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // resource bundles have been nulled out, remove all related 142251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // information from the cache. 142351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Object ref; 142451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while ((ref = referenceQueue.poll()) != null) { 142551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheList.remove(((CacheKeyReference)ref).getCacheKey()); 142651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 142751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 142851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // flag indicating the resource bundle has expired in the cache 142951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean expiredBundle = false; 143051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 143151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // First, look up the cache to see if it's in the cache, without 143251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // attempting to load bundle. 143351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.setLocale(targetLocale); 143451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle bundle = findBundleInCache(cacheKey, control); 143551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (isValidBundle(bundle)) { 143651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski expiredBundle = bundle.expired; 143751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!expiredBundle) { 143851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If its parent is the one asked for by the candidate 143951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // locales (the runtime lookup path), we can take the cached 144051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // one. (If it's not identical, then we'd have to check the 144151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // parent's parents to be consistent with what's been 144251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // requested.) 144351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle.parent == parent) { 144451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 144551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 144651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Otherwise, remove the cached one since we can't keep 144751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // the same bundles having different parents. 144851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski BundleReference bundleRef = cacheList.get(cacheKey); 144951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundleRef != null && bundleRef.get() == bundle) { 145051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheList.remove(cacheKey, bundleRef); 145151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 145251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 145351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 145451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 145551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle != NONEXISTENT_BUNDLE) { 145651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey constKey = (CacheKey) cacheKey.clone(); 145751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 145851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 145951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = loadBundle(cacheKey, formats, control, expiredBundle); 146051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle != null) { 146151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle.parent == null) { 146251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.setParent(parent); 146351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 146451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.locale = targetLocale; 146551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = putBundleInCache(cacheKey, bundle, control); 146651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 146751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 146851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 146951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Put NONEXISTENT_BUNDLE in the cache as a mark that there's no bundle 147051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // instance for the locale. 147151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski putBundleInCache(cacheKey, NONEXISTENT_BUNDLE, control); 147251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } finally { 147351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (constKey.getCause() instanceof InterruptedException) { 147451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Thread.currentThread().interrupt(); 147551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return parent; 147951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 148051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14817ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static ResourceBundle loadBundle(CacheKey cacheKey, 14827ff253db3117067931e9f249762812de7f3bf694Tobias Thierer List<String> formats, 14837ff253db3117067931e9f249762812de7f3bf694Tobias Thierer Control control, 14847ff253db3117067931e9f249762812de7f3bf694Tobias Thierer boolean reload) { 148551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 148651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Here we actually load the bundle in the order of formats 148751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // specified by the getFormats() value. 148851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Locale targetLocale = cacheKey.getLocale(); 148951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 149051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle bundle = null; 149151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int size = formats.size(); 149251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < size; i++) { 149351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String format = formats.get(i); 149451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 149551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = control.newBundle(cacheKey.getName(), targetLocale, format, 149651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.getLoader(), reload); 149751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (LinkageError error) { 149851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // We need to handle the LinkageError case due to 149951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // inconsistent case-sensitivity in ClassLoader. 150051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // See 6572242 for details. 150151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.setCause(error); 150251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (Exception cause) { 150351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.setCause(cause); 150451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 150551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle != null) { 150651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Set the format in the cache key so that it can be 150751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // used when calling needsReload later. 150851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.setFormat(format); 150951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.name = cacheKey.getName(); 151051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.locale = targetLocale; 151151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Bundle provider might reuse instances. So we should make 151251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // sure to clear the expired flag here. 151351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.expired = false; 151451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski break; 151551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 151651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 151751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 151851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 151951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 152051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 15217ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static boolean isValidBundle(ResourceBundle bundle) { 152251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle != null && bundle != NONEXISTENT_BUNDLE; 152351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 152451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 152551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 152651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Determines whether any of resource bundles in the parent chain, 152751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * including the leaf, have expired. 152851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 15297ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static boolean hasValidParentChain(ResourceBundle bundle) { 153051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long now = System.currentTimeMillis(); 153151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (bundle != null) { 153251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle.expired) { 153351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 153451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 153551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey key = bundle.cacheKey; 153651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (key != null) { 153751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long expirationTime = key.expirationTime; 153851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (expirationTime >= 0 && expirationTime <= now) { 153951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 154051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 154151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 154251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = bundle.parent; 154351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 154451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 154551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 154651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 154751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 154851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Throw a MissingResourceException with proper message 154951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 15507ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static void throwMissingResourceException(String baseName, 15517ff253db3117067931e9f249762812de7f3bf694Tobias Thierer Locale locale, 15527ff253db3117067931e9f249762812de7f3bf694Tobias Thierer Throwable cause) { 155351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If the cause is a MissingResourceException, avoid creating 155451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // a long chain. (6355009) 155551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cause instanceof MissingResourceException) { 155651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cause = null; 155751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 155851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new MissingResourceException("Can't find bundle for base name " 155951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski + baseName + ", locale " + locale, 156051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski baseName + "_" + locale, // className 156151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski "", // key 156251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cause); 156351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 156451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 156551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 156651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Finds a bundle in the cache. Any expired bundles are marked as 156751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * `expired' and removed from the cache upon return. 156851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 156951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param cacheKey the key to look up the cache 157051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param control the Control to be used for the expiration control 157151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the cached bundle, or null if the bundle is not found in the 157251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cache or its parent has expired. <code>bundle.expire</code> is true 157351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * upon return if the bundle in the cache has expired. 157451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 15757ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static ResourceBundle findBundleInCache(CacheKey cacheKey, 15767ff253db3117067931e9f249762812de7f3bf694Tobias Thierer Control control) { 157751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski BundleReference bundleRef = cacheList.get(cacheKey); 157851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundleRef == null) { 157951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 158051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 158151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle bundle = bundleRef.get(); 158251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle == null) { 158351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 158451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 158551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle p = bundle.parent; 158651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski assert p != NONEXISTENT_BUNDLE; 158751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If the parent has expired, then this one must also expire. We 158851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // check only the immediate parent because the actual loading is 158951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // done from the root (base) to leaf (child) and the purpose of 159051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // checking is to propagate expiration towards the leaf. For 159151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // example, if the requested locale is ja_JP_JP and there are 159251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // bundles for all of the candidates in the cache, we have a list, 159351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 159451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // base <- ja <- ja_JP <- ja_JP_JP 159551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 159651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If ja has expired, then it will reload ja and the list becomes a 159751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // tree. 159851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 159951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // base <- ja (new) 160051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // " <- ja (expired) <- ja_JP <- ja_JP_JP 160151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 160251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // When looking up ja_JP in the cache, it finds ja_JP in the cache 160351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // which references to the expired ja. Then, ja_JP is marked as 160451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // expired and removed from the cache. This will be propagated to 160551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // ja_JP_JP. 160651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 160751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Now, it's possible, for example, that while loading new ja_JP, 160851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // someone else has started loading the same bundle and finds the 160951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // base bundle has expired. Then, what we get from the first 161051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // getBundle call includes the expired base bundle. However, if 161151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // someone else didn't start its loading, we wouldn't know if the 161251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // base bundle has expired at the end of the loading process. The 161351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // expiration control doesn't guarantee that the returned bundle and 161451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // its parents haven't expired. 161551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 161651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // We could check the entire parent chain to see if there's any in 161751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // the chain that has expired. But this process may never end. An 161851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // extreme case would be that getTimeToLive returns 0 and 161951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // needsReload always returns true. 162051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (p != null && p.expired) { 162151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski assert bundle != NONEXISTENT_BUNDLE; 162251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.expired = true; 162351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.cacheKey = null; 162451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheList.remove(cacheKey, bundleRef); 162551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = null; 162651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 162751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey key = bundleRef.getCacheKey(); 162851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long expirationTime = key.expirationTime; 162951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!bundle.expired && expirationTime >= 0 && 163051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski expirationTime <= System.currentTimeMillis()) { 163151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // its TTL period has expired. 163251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle != NONEXISTENT_BUNDLE) { 163351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Synchronize here to call needsReload to avoid 163451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // redundant concurrent calls for the same bundle. 163551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized (bundle) { 163651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski expirationTime = key.expirationTime; 163751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!bundle.expired && expirationTime >= 0 && 163851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski expirationTime <= System.currentTimeMillis()) { 163951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 164051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.expired = control.needsReload(key.getName(), 164151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski key.getLocale(), 164251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski key.getFormat(), 164351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski key.getLoader(), 164451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle, 164551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski key.loadTime); 164651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (Exception e) { 164751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.setCause(e); 164851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 164951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle.expired) { 165051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If the bundle needs to be reloaded, then 165151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // remove the bundle from the cache, but 165251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // return the bundle with the expired flag 165351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // on. 165451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.cacheKey = null; 165551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheList.remove(cacheKey, bundleRef); 165651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 165751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Update the expiration control info. and reuse 165851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // the same bundle instance 165951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setExpirationTime(key, control); 166051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 166151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 166251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 166351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 166451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // We just remove NONEXISTENT_BUNDLE from the cache. 166551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheList.remove(cacheKey, bundleRef); 166651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = null; 166751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 166851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 166951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 167051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 167151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 167251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 167351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 167451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Put a new bundle in the cache. 167551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 167651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param cacheKey the key for the resource bundle 167751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param bundle the resource bundle to be put in the cache 167851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the ResourceBundle for the cacheKey; if someone has put 167951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the bundle before this call, the one found in the cache is 168051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returned. 168151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 16827ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static ResourceBundle putBundleInCache(CacheKey cacheKey, 16837ff253db3117067931e9f249762812de7f3bf694Tobias Thierer ResourceBundle bundle, 16847ff253db3117067931e9f249762812de7f3bf694Tobias Thierer Control control) { 168551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setExpirationTime(cacheKey, control); 168651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cacheKey.expirationTime != Control.TTL_DONT_CACHE) { 168751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CacheKey key = (CacheKey) cacheKey.clone(); 168851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski BundleReference bundleRef = new BundleReference(bundle, referenceQueue, key); 168951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.cacheKey = key; 169051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 169151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Put the bundle in the cache if it's not been in the cache. 169251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski BundleReference result = cacheList.putIfAbsent(key, bundleRef); 169351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 169451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If someone else has put the same bundle in the cache before 169551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // us and it has not expired, we should use the one in the cache. 169651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (result != null) { 169751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle rb = result.get(); 169851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (rb != null && !rb.expired) { 169951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Clear the back link to the cache key 170051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle.cacheKey = null; 170151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = rb; 170251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Clear the reference in the BundleReference so that 170351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // it won't be enqueued. 170451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundleRef.clear(); 170551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 170651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Replace the invalid (garbage collected or expired) 170751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // instance with the valid one. 170851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheList.put(key, bundleRef); 170951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 171051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 171151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 171251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 171351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 171451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 17157ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private static void setExpirationTime(CacheKey cacheKey, Control control) { 171651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long ttl = control.getTimeToLive(cacheKey.getName(), 171751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.getLocale()); 171851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (ttl >= 0) { 171951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If any expiration time is specified, set the time to be 172051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // expired in the cache. 172151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long now = System.currentTimeMillis(); 172251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.loadTime = now; 172351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.expirationTime = now + ttl; 172451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (ttl >= Control.TTL_NO_EXPIRATION_CONTROL) { 172551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cacheKey.expirationTime = ttl; 172651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 172751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Invalid Control: TTL=" + ttl); 172851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 172951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 173051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 173151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 173251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Removes all resource bundles from the cache that have been loaded 173351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * using the caller's class loader. 173451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 173551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 173651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see ResourceBundle.Control#getTimeToLive(String,Locale) 173751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 173851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski @CallerSensitive 173951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final void clearCache() { 17407ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: use of VMStack.getCallingClassLoader() 17419c853c5b9ebbb0ef60a013ae10ee411d70dfa832Piotr Jastrzebski clearCache(getLoader(VMStack.getCallingClassLoader())); 17427ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // clearCache(getLoader(Reflection.getCallerClass())); 174351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 174451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 174551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 174651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Removes all resource bundles from the cache that have been loaded 174751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * using the given class loader. 174851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 174951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param loader the class loader 175051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException if <code>loader</code> is null 175151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 175251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see ResourceBundle.Control#getTimeToLive(String,Locale) 175351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 175451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final void clearCache(ClassLoader loader) { 175551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (loader == null) { 175651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 175751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 175851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Set<CacheKey> set = cacheList.keySet(); 175951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (CacheKey key : set) { 176051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (key.getLoader() == loader) { 176151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski set.remove(key); 176251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 176351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 176451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 176551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 176651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 176751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Gets an object for the given key from this resource bundle. 176851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns null if this resource bundle does not contain an 176951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * object for the given key. 177051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 177151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key the key for the desired object 177251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException if <code>key</code> is <code>null</code> 177351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the object for the given key, or null 177451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 177551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract Object handleGetObject(String key); 177651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 177751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 177851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns an enumeration of the keys. 177951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 178051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return an <code>Enumeration</code> of the keys contained in 178151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this <code>ResourceBundle</code> and its parent bundles. 178251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 178351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract Enumeration<String> getKeys(); 178451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 178551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 178651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Determines whether the given <code>key</code> is contained in 178751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this <code>ResourceBundle</code> or its parent bundles. 178851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 178951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key 179051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the resource <code>key</code> 179151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <code>true</code> if the given <code>key</code> is 179251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * contained in this <code>ResourceBundle</code> or its 179351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * parent bundles; <code>false</code> otherwise. 179451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 179551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>key</code> is <code>null</code> 179651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 179751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 179851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean containsKey(String key) { 179951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (key == null) { 180051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 180151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 180251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (ResourceBundle rb = this; rb != null; rb = rb.parent) { 180351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (rb.handleKeySet().contains(key)) { 180451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 180551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 180651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 180751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 180851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 180951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 181051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 181151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>Set</code> of all keys contained in this 181251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> and its parent bundles. 181351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 181451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>Set</code> of all keys contained in this 181551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> and its parent bundles. 181651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 181751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 181851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Set<String> keySet() { 181951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Set<String> keys = new HashSet<>(); 182051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (ResourceBundle rb = this; rb != null; rb = rb.parent) { 182151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski keys.addAll(rb.handleKeySet()); 182251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 182351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return keys; 182451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 182551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 182651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 182751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>Set</code> of the keys contained <em>only</em> 182851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in this <code>ResourceBundle</code>. 182951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 183051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation returns a <code>Set</code> of the 183151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * keys returned by the {@link #getKeys() getKeys} method except 183251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for the ones for which the {@link #handleGetObject(String) 183351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * handleGetObject} method returns <code>null</code>. Once the 183451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Set</code> has been created, the value is kept in this 183551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> in order to avoid producing the 183651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same <code>Set</code> in subsequent calls. Subclasses can 183751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * override this method for faster handling. 183851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 183951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>Set</code> of the keys contained only in this 184051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> 184151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 184251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 184351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected Set<String> handleKeySet() { 184451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (keySet == null) { 184551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized (this) { 184651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (keySet == null) { 184751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Set<String> keys = new HashSet<>(); 184851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Enumeration<String> enumKeys = getKeys(); 184951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (enumKeys.hasMoreElements()) { 185051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String key = enumKeys.nextElement(); 185151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (handleGetObject(key) != null) { 185251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski keys.add(key); 185351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 185451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 185551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski keySet = keys; 185651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 185751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 185851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 185951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return keySet; 186051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 186151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 186251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 186351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 186451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 186551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code> defines a set of callback methods 186651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that are invoked by the {@link ResourceBundle#getBundle(String, 186751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale, ClassLoader, Control) ResourceBundle.getBundle} factory 186851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * methods during the bundle loading process. In other words, a 186951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code> collaborates with the factory 187051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * methods for loading resource bundles. The default implementation of 187151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the callback methods provides the information necessary for the 187251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * factory methods to perform the <a 187351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="./ResourceBundle.html#default_behavior">default behavior</a>. 187451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 187551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>In addition to the callback methods, the {@link 187651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #toBundleName(String, Locale) toBundleName} and {@link 187751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #toResourceName(String, String) toResourceName} methods are defined 187851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * primarily for convenience in implementing the callback 187951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * methods. However, the <code>toBundleName</code> method could be 188051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * overridden to provide different conventions in the organization and 188151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * packaging of localized resources. The <code>toResourceName</code> 188251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method is <code>final</code> to avoid use of wrong resource and class 188351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name separators. 188451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 188551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Two factory methods, {@link #getControl(List)} and {@link 188651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getNoFallbackControl(List)}, provide 188751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code> instances that implement common 188851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * variations of the default bundle loading process. 188951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 189051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The formats returned by the {@link Control#getFormats(String) 189151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getFormats} method and candidate locales returned by the {@link 189251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle.Control#getCandidateLocales(String, Locale) 189351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getCandidateLocales} method must be consistent in all 189451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> invocations for the same base 189551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle. Otherwise, the <code>ResourceBundle.getBundle</code> methods 189651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * may return unintended bundles. For example, if only 189751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"java.class"</code> is returned by the <code>getFormats</code> 189851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method for the first call to <code>ResourceBundle.getBundle</code> 189951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and only <code>"java.properties"</code> for the second call, then the 190051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * second call will return the class-based one that has been cached 190151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * during the first call. 190251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 190351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>A <code>ResourceBundle.Control</code> instance must be thread-safe 190451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if it's simultaneously used by multiple threads. 190551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> does not synchronize to call 190651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <code>ResourceBundle.Control</code> methods. The default 190751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementations of the methods are thread-safe. 190851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 190951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Applications can specify <code>ResourceBundle.Control</code> 191051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instances returned by the <code>getControl</code> factory methods or 191151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * created from a subclass of <code>ResourceBundle.Control</code> to 191251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * customize the bundle loading process. The following are examples of 191351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * changing the default bundle loading process. 191451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 191551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><b>Example 1</b> 191651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 191751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The following code lets <code>ResourceBundle.getBundle</code> look 191851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * up only properties-based resources. 191951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 192051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 192151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * import java.util.*; 192251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * import static java.util.ResourceBundle.Control.*; 192351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ... 192451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle bundle = 192551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle.getBundle("MyResources", new Locale("fr", "CH"), 192651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle.Control.getControl(FORMAT_PROPERTIES)); 192751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 192851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 192951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Given the resource bundles in the <a 193051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="./ResourceBundle.html#default_behavior_example">example</a> in 193151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <code>ResourceBundle.getBundle</code> description, this 193251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> call loads 193351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>MyResources_fr_CH.properties</code> whose parent is 193451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>MyResources_fr.properties</code> whose parent is 193551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>MyResources.properties</code>. (<code>MyResources_fr_CH.properties</code> 193651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is not hidden, but <code>MyResources_fr_CH.class</code> is.) 193751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 193851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><b>Example 2</b> 193951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 194051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The following is an example of loading XML-based bundles 194151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * using {@link Properties#loadFromXML(java.io.InputStream) 194251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Properties.loadFromXML}. 194351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 194451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 194551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle rb = ResourceBundle.getBundle("Messages", 194651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * new ResourceBundle.Control() { 194751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public List<String> getFormats(String baseName) { 194851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (baseName == null) 194951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * throw new NullPointerException(); 195051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return Arrays.asList("xml"); 195151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 195251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public ResourceBundle newBundle(String baseName, 195351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale locale, 195451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * String format, 195551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ClassLoader loader, 195651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * boolean reload) 195751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * throws IllegalAccessException, 195851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * InstantiationException, 195951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * IOException { 196051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (baseName == null || locale == null 196151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * || format == null || loader == null) 196251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * throw new NullPointerException(); 196351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ResourceBundle bundle = null; 196451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (format.equals("xml")) { 196551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * String bundleName = toBundleName(baseName, locale); 196651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * String resourceName = toResourceName(bundleName, format); 196751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * InputStream stream = null; 196851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (reload) { 196951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * URL url = loader.getResource(resourceName); 197051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (url != null) { 197151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * URLConnection connection = url.openConnection(); 197251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (connection != null) { 197351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // Disable caches to get fresh data for 197451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // reloading. 197551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * connection.setUseCaches(false); 197651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * stream = connection.getInputStream(); 197751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 197851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 197951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } else { 198051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * stream = loader.getResourceAsStream(resourceName); 198151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 198251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (stream != null) { 198351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * BufferedInputStream bis = new BufferedInputStream(stream); 198451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle = new XMLResourceBundle(bis); 198551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bis.close(); 198651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 198751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 198851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return bundle; 198951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 199051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * }); 199151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 199251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ... 199351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 199451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * private static class XMLResourceBundle extends ResourceBundle { 199551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * private Properties props; 199651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * XMLResourceBundle(InputStream stream) throws IOException { 199751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * props = new Properties(); 199851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * props.loadFromXML(stream); 199951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 200051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * protected Object handleGetObject(String key) { 200151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return props.getProperty(key); 200251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 200351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * public Enumeration<String> getKeys() { 200451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ... 200551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 200651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 200751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 200851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 200951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.6 201051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 201151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static class Control { 201251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 201351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The default format <code>List</code>, which contains the strings 201451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"java.class"</code> and <code>"java.properties"</code>, in 201551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this order. This <code>List</code> is {@linkplain 201651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Collections#unmodifiableList(List) unmodifiable}. 201751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 201851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getFormats(String) 201951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 202051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final List<String> FORMAT_DEFAULT 202151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = Collections.unmodifiableList(Arrays.asList("java.class", 202251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski "java.properties")); 202351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 202451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 202551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The class-only format <code>List</code> containing 202651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"java.class"</code>. This <code>List</code> is {@linkplain 202751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Collections#unmodifiableList(List) unmodifiable}. 202851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 202951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getFormats(String) 203051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 203151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final List<String> FORMAT_CLASS 203251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = Collections.unmodifiableList(Arrays.asList("java.class")); 203351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 203451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 203551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The properties-only format <code>List</code> containing 203651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"java.properties"</code>. This <code>List</code> is 203751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@linkplain Collections#unmodifiableList(List) unmodifiable}. 203851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 203951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getFormats(String) 204051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 204151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final List<String> FORMAT_PROPERTIES 204251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = Collections.unmodifiableList(Arrays.asList("java.properties")); 204351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 204451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 204551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The time-to-live constant for not caching loaded resource bundle 204651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instances. 204751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 204851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getTimeToLive(String, Locale) 204951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 205051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final long TTL_DONT_CACHE = -1; 205151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 205251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 205351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The time-to-live constant for disabling the expiration control 205451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for loaded resource bundle instances in the cache. 205551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 205651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getTimeToLive(String, Locale) 205751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 205851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final long TTL_NO_EXPIRATION_CONTROL = -2; 205951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 206051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final Control INSTANCE = new Control(); 206151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 206251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 206351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Sole constructor. (For invocation by subclass constructors, 206451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * typically implicit.) 206551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 206651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected Control() { 206751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 206851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 206951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 207051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>ResourceBundle.Control</code> in which the {@link 207151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getFormats(String) getFormats} method returns the specified 207251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>formats</code>. The <code>formats</code> must be equal to 207351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * one of {@link Control#FORMAT_PROPERTIES}, {@link 207451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#FORMAT_CLASS} or {@link 207551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#FORMAT_DEFAULT}. <code>ResourceBundle.Control</code> 207651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instances returned by this method are singletons and thread-safe. 207751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 207851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Specifying {@link Control#FORMAT_DEFAULT} is equivalent to 207951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instantiating the <code>ResourceBundle.Control</code> class, 208051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that this method returns a singleton. 208151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 208251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param formats 208351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the formats to be returned by the 208451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control.getFormats</code> method 208551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>ResourceBundle.Control</code> supporting the 208651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specified <code>formats</code> 208751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 208851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>formats</code> is <code>null</code> 208951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalArgumentException 209051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>formats</code> is unknown 209151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 209251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final Control getControl(List<String> formats) { 209351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (formats.equals(Control.FORMAT_PROPERTIES)) { 209451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return SingleFormatControl.PROPERTIES_ONLY; 209551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 209651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (formats.equals(Control.FORMAT_CLASS)) { 209751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return SingleFormatControl.CLASS_ONLY; 209851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 209951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (formats.equals(Control.FORMAT_DEFAULT)) { 210051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return Control.INSTANCE; 210151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 210251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException(); 210351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 210451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 210551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 210651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>ResourceBundle.Control</code> in which the {@link 210751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getFormats(String) getFormats} method returns the specified 210851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>formats</code> and the {@link 210951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#getFallbackLocale(String, Locale) getFallbackLocale} 211051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method returns <code>null</code>. The <code>formats</code> must 211151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * be equal to one of {@link Control#FORMAT_PROPERTIES}, {@link 211251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Control#FORMAT_CLASS} or {@link Control#FORMAT_DEFAULT}. 211351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code> instances returned by this 211451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method are singletons and thread-safe. 211551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 211651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param formats 211751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the formats to be returned by the 211851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control.getFormats</code> method 211951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>ResourceBundle.Control</code> supporting the 212051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specified <code>formats</code> with no fallback 212151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code> support 212251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 212351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>formats</code> is <code>null</code> 212451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalArgumentException 212551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>formats</code> is unknown 212651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 212751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static final Control getNoFallbackControl(List<String> formats) { 212851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (formats.equals(Control.FORMAT_DEFAULT)) { 212951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return NoFallbackControl.NO_FALLBACK; 213051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 213151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (formats.equals(Control.FORMAT_PROPERTIES)) { 213251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return NoFallbackControl.PROPERTIES_ONLY_NO_FALLBACK; 213351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 213451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (formats.equals(Control.FORMAT_CLASS)) { 213551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return NoFallbackControl.CLASS_ONLY_NO_FALLBACK; 213651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 213751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException(); 213851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 213951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 214051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 214151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>List</code> of <code>String</code>s containing 214251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * formats to be used to load resource bundles for the given 214351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>baseName</code>. The <code>ResourceBundle.getBundle</code> 214451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * factory method tries to load resource bundles with formats in the 214551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * order specified by the list. The list returned by this method 214651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * must have at least one <code>String</code>. The predefined 214751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * formats are <code>"java.class"</code> for class-based resource 214851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundles and <code>"java.properties"</code> for {@linkplain 214951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * PropertyResourceBundle properties-based} ones. Strings starting 215051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with <code>"java."</code> are reserved for future extensions and 215151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * must not be used by application-defined formats. 215251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 215351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>It is not a requirement to return an immutable (unmodifiable) 215451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>List</code>. However, the returned <code>List</code> must 215551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not be mutated after it has been returned by 215651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>getFormats</code>. 215751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 215851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation returns {@link #FORMAT_DEFAULT} so 215951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that the <code>ResourceBundle.getBundle</code> factory method 216051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * looks up first class-based resource bundles, then 216151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * properties-based ones. 216251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 216351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 216451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully qualified class 216551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name 216651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>List</code> of <code>String</code>s containing 216751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * formats for loading resource bundles. 216851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 216951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> is null 217051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #FORMAT_DEFAULT 217151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #FORMAT_CLASS 217251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #FORMAT_PROPERTIES 217351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 217451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public List<String> getFormats(String baseName) { 217551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseName == null) { 217651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 217751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 217851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return FORMAT_DEFAULT; 217951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 218051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 218151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 218251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>List</code> of <code>Locale</code>s as candidate 218351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locales for <code>baseName</code> and <code>locale</code>. This 218451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method is called by the <code>ResourceBundle.getBundle</code> 218551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * factory method each time the factory method tries finding a 218651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle for a target <code>Locale</code>. 218751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 218851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The sequence of the candidate locales also corresponds to the 218951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * runtime resource lookup path (also known as the <I>parent 219051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * chain</I>), if the corresponding resource bundles for the 219151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate locales exist and their parents are not defined by 219251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loaded resource bundles themselves. The last element of the list 219351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * must be a {@linkplain Locale#ROOT root locale} if it is desired to 219451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * have the base bundle as the terminal of the parent chain. 219551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 219651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If the given locale is equal to <code>Locale.ROOT</code> (the 219751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * root locale), a <code>List</code> containing only the root 219851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code> must be returned. In this case, the 219951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> factory method loads only 220051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base bundle as the resulting resource bundle. 220151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 220251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>It is not a requirement to return an immutable (unmodifiable) 220351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>List</code>. However, the returned <code>List</code> must not 220451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * be mutated after it has been returned by 220551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>getCandidateLocales</code>. 220651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 220751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation returns a <code>List</code> containing 220851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code>s using the rules described below. In the 220951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * description below, <em>L</em>, <em>S</em>, <em>C</em> and <em>V</em> 221051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * respectively represent non-empty language, script, country, and 221151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * variant. For example, [<em>L</em>, <em>C</em>] represents a 221251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code> that has non-empty values only for language and 221351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * country. The form <em>L</em>("xx") represents the (non-empty) 221451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * language value is "xx". For all cases, <code>Locale</code>s whose 221551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * final component values are empty strings are omitted. 221651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 221751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ol><li>For an input <code>Locale</code> with an empty script value, 221851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * append candidate <code>Locale</code>s by omitting the final component 221951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * one by one as below: 222051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 222151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 22227ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>, <em>V</em>] </li> 22237ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>] </li> 22247ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>] </li> 22257ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code> </li> 22267ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * </ul></li> 222751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 222851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>For an input <code>Locale</code> with a non-empty script value, 222951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * append candidate <code>Locale</code>s by omitting the final component 223051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * up to language, then append candidates generated from the 223151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code> with country and variant restored: 223251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 223351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 22347ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>, <em>C</em>, <em>V</em>]</li> 22357ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>, <em>C</em>]</li> 22367ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>]</li> 22377ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>, <em>V</em>]</li> 22387ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>]</li> 22397ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>]</li> 22407ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code></li> 22417ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * </ul></li> 224251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 224351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>For an input <code>Locale</code> with a variant value consisting 224451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of multiple subtags separated by underscore, generate candidate 224551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code>s by omitting the variant subtags one by one, then 22467ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * insert them after every occurrence of <code> Locale</code>s with the 224751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * full variant value in the original list. For example, if the 224851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the variant consists of two subtags <em>V1</em> and <em>V2</em>: 224951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 225051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 22517ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>, <em>C</em>, <em>V1</em>, <em>V2</em>]</li> 22527ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>, <em>C</em>, <em>V1</em>]</li> 22537ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>, <em>C</em>]</li> 22547ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>S</em>]</li> 22557ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>, <em>V1</em>, <em>V2</em>]</li> 22567ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>, <em>V1</em>]</li> 22577ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>, <em>C</em>]</li> 22587ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>]</li> 22597ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code></li> 22607ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * </ul></li> 226151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 226251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Special cases for Chinese. When an input <code>Locale</code> has the 226351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * language "zh" (Chinese) and an empty script value, either "Hans" (Simplified) or 226451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "Hant" (Traditional) might be supplied, depending on the country. 226551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * When the country is "CN" (China) or "SG" (Singapore), "Hans" is supplied. 226651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * When the country is "HK" (Hong Kong SAR China), "MO" (Macau SAR China), 226751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or "TW" (Taiwan), "Hant" is supplied. For all other countries or when the country 226851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is empty, no script is supplied. For example, for <code>Locale("zh", "CN") 226951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </code>, the candidate list will be: 227051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 22717ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh"), <em>S</em>("Hans"), <em>C</em>("CN")]</li> 22727ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh"), <em>S</em>("Hans")]</li> 22737ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh"), <em>C</em>("CN")]</li> 22747ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh")]</li> 22757ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code></li> 227651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 227751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 227851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * For <code>Locale("zh", "TW")</code>, the candidate list will be: 227951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 22807ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh"), <em>S</em>("Hant"), <em>C</em>("TW")]</li> 22817ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh"), <em>S</em>("Hant")]</li> 22827ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh"), <em>C</em>("TW")]</li> 22837ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("zh")]</li> 22847ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code></li> 22857ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * </ul></li> 228651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 228751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>Special cases for Norwegian. Both <code>Locale("no", "NO", 228851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "NY")</code> and <code>Locale("nn", "NO")</code> represent Norwegian 228951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Nynorsk. When a locale's language is "nn", the standard candidate 229051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * list is generated up to [<em>L</em>("nn")], and then the following 229151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidates are added: 229251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22937ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <ul><li> [<em>L</em>("no"), <em>C</em>("NO"), <em>V</em>("NY")]</li> 22947ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("no"), <em>C</em>("NO")]</li> 22957ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("no")]</li> 22967ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code></li> 229751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 229851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 229951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the locale is exactly <code>Locale("no", "NO", "NY")</code>, it is first 230051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * converted to <code>Locale("nn", "NO")</code> and then the above procedure is 230151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * followed. 230251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 230351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Also, Java treats the language "no" as a synonym of Norwegian 230451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Bokmål "nb". Except for the single case <code>Locale("no", 230551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "NO", "NY")</code> (handled above), when an input <code>Locale</code> 230651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has language "no" or "nb", candidate <code>Locale</code>s with 230751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * language code "no" and "nb" are interleaved, first using the 230851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * requested language, then using its synonym. For example, 230951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("nb", "NO", "POSIX")</code> generates the following 231051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * candidate list: 231151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 231251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 23137ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("nb"), <em>C</em>("NO"), <em>V</em>("POSIX")]</li> 23147ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("no"), <em>C</em>("NO"), <em>V</em>("POSIX")]</li> 23157ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("nb"), <em>C</em>("NO")]</li> 23167ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("no"), <em>C</em>("NO")]</li> 23177ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("nb")]</li> 23187ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> [<em>L</em>("no")]</li> 23197ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <li> <code>Locale.ROOT</code></li> 232051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 232151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 232251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("no", "NO", "POSIX")</code> would generate the same list 232351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that locales with "no" would appear before the corresponding 232451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locales with "nb".</li> 232551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ol> 232651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 232751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation uses an {@link ArrayList} that 232851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * overriding implementations may modify before returning it to the 232951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * caller. However, a subclass must not modify it after it has 233051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * been returned by <code>getCandidateLocales</code>. 233151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 233251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>For example, if the given <code>baseName</code> is "Messages" 233351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and the given <code>locale</code> is 233451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("ja", "", "XX")</code>, then a 233551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>List</code> of <code>Locale</code>s: 233651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 233751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale("ja", "", "XX") 233851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale("ja") 233951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale.ROOT 234051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 234151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is returned. And if the resource bundles for the "ja" and 234251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "" <code>Locale</code>s are found, then the runtime resource 234351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * lookup path (parent chain) is: 23447ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * <pre>{@code 234551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Messages_ja -> Messages 23467ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * }</pre> 234751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 234851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 234951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully 235051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * qualified class name 235151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 235251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which a resource bundle is desired 235351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>List</code> of candidate 235451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale</code>s for the given <code>locale</code> 235551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 235651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> or <code>locale</code> is 235751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code> 235851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 235951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public List<Locale> getCandidateLocales(String baseName, Locale locale) { 236051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseName == null) { 236151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 236251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 236351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return new ArrayList<>(CANDIDATES_CACHE.get(locale.getBaseLocale())); 236451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 236551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 236651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final CandidateListCache CANDIDATES_CACHE = new CandidateListCache(); 236751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 236851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static class CandidateListCache extends LocaleObjectCache<BaseLocale, List<Locale>> { 236951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected List<Locale> createObject(BaseLocale base) { 237051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String language = base.getLanguage(); 237151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String script = base.getScript(); 237251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String region = base.getRegion(); 237351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String variant = base.getVariant(); 237451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 237551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Special handling for Norwegian 237651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean isNorwegianBokmal = false; 237751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean isNorwegianNynorsk = false; 237851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (language.equals("no")) { 237951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (region.equals("NO") && variant.equals("NY")) { 238051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski variant = ""; 238151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski isNorwegianNynorsk = true; 238251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 238351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski isNorwegianBokmal = true; 238451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 238551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 238651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (language.equals("nb") || isNorwegianBokmal) { 238751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<Locale> tmpList = getDefaultList("nb", script, region, variant); 238851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Insert a locale replacing "nb" with "no" for every list entry 238951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<Locale> bokmalList = new LinkedList<>(); 239051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (Locale l : tmpList) { 239151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bokmalList.add(l); 239251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (l.getLanguage().length() == 0) { 239351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski break; 239451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 239551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bokmalList.add(Locale.getInstance("no", l.getScript(), l.getCountry(), 239651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski l.getVariant(), null)); 239751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 239851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bokmalList; 239951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (language.equals("nn") || isNorwegianNynorsk) { 240051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Insert no_NO_NY, no_NO, no after nn 240151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<Locale> nynorskList = getDefaultList("nn", script, region, variant); 240251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int idx = nynorskList.size() - 1; 240351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski nynorskList.add(idx++, Locale.getInstance("no", "NO", "NY")); 240451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski nynorskList.add(idx++, Locale.getInstance("no", "NO", "")); 240551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski nynorskList.add(idx++, Locale.getInstance("no", "", "")); 240651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return nynorskList; 240751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 240851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Special handling for Chinese 240951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski else if (language.equals("zh")) { 241051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (script.length() == 0 && region.length() > 0) { 241151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Supply script for users who want to use zh_Hans/zh_Hant 241251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // as bundle names (recommended for Java7+) 24137ff253db3117067931e9f249762812de7f3bf694Tobias Thierer switch (region) { 24147ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "TW": 24157ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "HK": 24167ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "MO": 241751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski script = "Hant"; 24187ff253db3117067931e9f249762812de7f3bf694Tobias Thierer break; 24197ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "CN": 24207ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "SG": 242151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski script = "Hans"; 24227ff253db3117067931e9f249762812de7f3bf694Tobias Thierer break; 242351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 242451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (script.length() > 0 && region.length() == 0) { 242551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Supply region(country) for users who still package Chinese 242651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // bundles using old convension. 24277ff253db3117067931e9f249762812de7f3bf694Tobias Thierer switch (script) { 24287ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "Hans": 242951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski region = "CN"; 24307ff253db3117067931e9f249762812de7f3bf694Tobias Thierer break; 24317ff253db3117067931e9f249762812de7f3bf694Tobias Thierer case "Hant": 243251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski region = "TW"; 24337ff253db3117067931e9f249762812de7f3bf694Tobias Thierer break; 243451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 243551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 243651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 243751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 243851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getDefaultList(language, script, region, variant); 243951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 244051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 244151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static List<Locale> getDefaultList(String language, String script, String region, String variant) { 244251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<String> variants = null; 244351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 244451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (variant.length() > 0) { 244551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski variants = new LinkedList<>(); 244651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int idx = variant.length(); 244751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (idx != -1) { 244851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski variants.add(variant.substring(0, idx)); 244951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski idx = variant.lastIndexOf('_', --idx); 245051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 245151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 245251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 245351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski List<Locale> list = new LinkedList<>(); 245451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 245551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (variants != null) { 245651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (String v : variants) { 245751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.getInstance(language, script, region, v, null)); 245851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 245951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 246051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (region.length() > 0) { 246151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.getInstance(language, script, region, "", null)); 246251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 246351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (script.length() > 0) { 246451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.getInstance(language, script, "", "", null)); 246551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 246651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // With script, after truncating variant, region and script, 246751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // start over without script. 246851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (variants != null) { 246951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (String v : variants) { 247051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.getInstance(language, "", region, v, null)); 247151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 247251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 247351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (region.length() > 0) { 247451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.getInstance(language, "", region, "", null)); 247551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 247651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 247751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (language.length() > 0) { 247851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.getInstance(language, "", "", "", null)); 247951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 248051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Add root locale at the end 248151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski list.add(Locale.ROOT); 248251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 248351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return list; 248451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 248551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 248651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 248751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 248851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a <code>Locale</code> to be used as a fallback locale for 248951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * further resource bundle searches by the 249051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> factory method. This method 249151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is called from the factory method every time when no resulting 249251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle has been found for <code>baseName</code> and 249351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>locale</code>, where locale is either the parameter for 249451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> or the previous fallback 249551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale returned by this method. 249651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 249751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The method returns <code>null</code> if no further fallback 249851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * search is desired. 249951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 250051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation returns the {@linkplain 250151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale#getDefault() default <code>Locale</code>} if the given 250251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>locale</code> isn't the default one. Otherwise, 250351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code> is returned. 250451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 250551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 250651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully 250751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * qualified class name for which 250851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> has been 250951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * unable to find any resource bundles (except for the 251051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * base bundle) 251151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 251251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <code>Locale</code> for which 251351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> has been 251451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * unable to find any resource bundles (except for the 251551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * base bundle) 251651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return a <code>Locale</code> for the fallback search, 251751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or <code>null</code> if no further fallback search 251851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is desired. 251951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 252051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> or <code>locale</code> 252151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is <code>null</code> 252251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 252351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Locale getFallbackLocale(String baseName, Locale locale) { 252451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseName == null) { 252551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 252651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 252751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Locale defaultLocale = Locale.getDefault(); 252851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return locale.equals(defaultLocale) ? null : defaultLocale; 252951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 253051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 253151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 253251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Instantiates a resource bundle for the given bundle name of the 253351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * given format and locale, using the given class loader if 253451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * necessary. This method returns <code>null</code> if there is no 253551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundle available for the given parameters. If a resource 253651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle can't be instantiated due to an unexpected error, the 253751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * error must be reported by throwing an <code>Error</code> or 253851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Exception</code> rather than simply returning 253951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code>. 254051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 254151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If the <code>reload</code> flag is <code>true</code>, it 254251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * indicates that this method is being called because the previously 254351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loaded resource bundle has expired. 254451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 254551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation instantiates a 254651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> as follows. 254751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 254851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 254951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 255051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>The bundle name is obtained by calling {@link 255151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #toBundleName(String, Locale) toBundleName(baseName, 255251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale)}.</li> 255351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 255451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>If <code>format</code> is <code>"java.class"</code>, the 255551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Class} specified by the bundle name is loaded by calling 255651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link ClassLoader#loadClass(String)}. Then, a 255751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle</code> is instantiated by calling {@link 255851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Class#newInstance()}. Note that the <code>reload</code> flag is 255951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ignored for loading class-based resource bundles in this default 256051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementation.</li> 256151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 256251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>If <code>format</code> is <code>"java.properties"</code>, 256351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #toResourceName(String, String) toResourceName(bundlename, 256451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "properties")} is called to get the resource name. 256551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If <code>reload</code> is <code>true</code>, {@link 256651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ClassLoader#getResource(String) load.getResource} is called 256751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to get a {@link URL} for creating a {@link 256851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * URLConnection}. This <code>URLConnection</code> is used to 256951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@linkplain URLConnection#setUseCaches(boolean) disable the 257051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * caches} of the underlying resource loading layers, 257151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and to {@linkplain URLConnection#getInputStream() get an 257251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>InputStream</code>}. 257351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Otherwise, {@link ClassLoader#getResourceAsStream(String) 257451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loader.getResourceAsStream} is called to get an {@link 257551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * InputStream}. Then, a {@link 257651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * PropertyResourceBundle} is constructed with the 257751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>InputStream</code>.</li> 257851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 257951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li>If <code>format</code> is neither <code>"java.class"</code> 258051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * nor <code>"java.properties"</code>, an 258151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>IllegalArgumentException</code> is thrown.</li> 258251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 258351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 258451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 258551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 258651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base bundle name of the resource bundle, a fully 258751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * qualified class name 258851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 258951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which the resource bundle should be 259051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instantiated 259151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param format 259251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the resource bundle format to be loaded 259351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param loader 259451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <code>ClassLoader</code> to use to load the bundle 259551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param reload 259651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the flag to indicate bundle reloading; <code>true</code> 259751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if reloading an expired resource bundle, 259851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>false</code> otherwise 259951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the resource bundle instance, 260051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or <code>null</code> if none could be found. 260151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 260251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>bundleName</code>, <code>locale</code>, 260351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>format</code>, or <code>loader</code> is 260451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code>, or if <code>null</code> is returned by 260551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #toBundleName(String, Locale) toBundleName} 260651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalArgumentException 260751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>format</code> is unknown, or if the resource 260851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * found for the given parameters contains malformed data. 260951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception ClassCastException 261051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the loaded class cannot be cast to <code>ResourceBundle</code> 261151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IllegalAccessException 261251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the class or its nullary constructor is not 261351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accessible. 261451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception InstantiationException 261551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the instantiation of a class fails for some other 261651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * reason. 261751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception ExceptionInInitializerError 261851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the initialization provoked by this method fails. 261951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception SecurityException 262051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If a security manager is present and creation of new 262151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instances is denied. See {@link Class#newInstance()} 262251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for details. 262351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception IOException 262451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if an error occurred when reading resources using 262551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * any I/O operations 262651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 262751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public ResourceBundle newBundle(String baseName, Locale locale, String format, 262851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader loader, boolean reload) 262951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws IllegalAccessException, InstantiationException, IOException { 263051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String bundleName = toBundleName(baseName, locale); 263151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle bundle = null; 263251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (format.equals("java.class")) { 263351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 26347ff253db3117067931e9f249762812de7f3bf694Tobias Thierer @SuppressWarnings("unchecked") 263551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Class<? extends ResourceBundle> bundleClass 263651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = (Class<? extends ResourceBundle>)loader.loadClass(bundleName); 263751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 263851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // If the class isn't a ResourceBundle subclass, throw a 263951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // ClassCastException. 264051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (ResourceBundle.class.isAssignableFrom(bundleClass)) { 264151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bundle = bundleClass.newInstance(); 264251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 264351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new ClassCastException(bundleClass.getName() 264451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski + " cannot be cast to ResourceBundle"); 264551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 264651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (ClassNotFoundException e) { 264751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 264851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (format.equals("java.properties")) { 26497ff253db3117067931e9f249762812de7f3bf694Tobias Thierer final String resourceName = toResourceName0(bundleName, "properties"); 26507ff253db3117067931e9f249762812de7f3bf694Tobias Thierer if (resourceName == null) { 26517ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return bundle; 26527ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 265351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski final ClassLoader classLoader = loader; 265451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski final boolean reloadFlag = reload; 265551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski InputStream stream = null; 265651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 265751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski stream = AccessController.doPrivileged( 265851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedExceptionAction<InputStream>() { 265951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public InputStream run() throws IOException { 266051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski InputStream is = null; 266151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (reloadFlag) { 266251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski URL url = classLoader.getResource(resourceName); 266351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (url != null) { 266451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski URLConnection connection = url.openConnection(); 266551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (connection != null) { 266651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Disable caches to get fresh data for 266751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // reloading. 266851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski connection.setUseCaches(false); 266951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski is = connection.getInputStream(); 267051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 267151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 267251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 267351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski is = classLoader.getResourceAsStream(resourceName); 267451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 267551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return is; 267651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 267751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }); 267851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (PrivilegedActionException e) { 267951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw (IOException) e.getException(); 268051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 268151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (stream != null) { 268251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 26837ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // Android-changed: Use UTF-8 for property based resources. b/26879578 2684ac8051d6632fe2e0d2c50b0d519e21fa7030f2a0Narayan Kamath bundle = new PropertyResourceBundle( 2685ac8051d6632fe2e0d2c50b0d519e21fa7030f2a0Narayan Kamath new InputStreamReader(stream, StandardCharsets.UTF_8)); 26867ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // bundle = new PropertyResourceBundle(stream); 268751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } finally { 268851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski stream.close(); 268951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 269051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 269151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 269251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("unknown format: " + format); 269351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 269451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return bundle; 269551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 269651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 269751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 269851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the time-to-live (TTL) value for resource bundles that 269951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are loaded under this 270051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.Control</code>. Positive time-to-live values 270151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specify the number of milliseconds a bundle can remain in the 270251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cache without being validated against the source data from which 270351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it was constructed. The value 0 indicates that a bundle must be 270451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * validated each time it is retrieved from the cache. {@link 270551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #TTL_DONT_CACHE} specifies that loaded resource bundles are not 270651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * put in the cache. {@link #TTL_NO_EXPIRATION_CONTROL} specifies 270751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that loaded resource bundles are put in the cache with no 270851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * expiration control. 270951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 271051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The expiration affects only the bundle loading process by the 271151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>ResourceBundle.getBundle</code> factory method. That is, 271251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if the factory method finds a resource bundle in the cache that 271351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has expired, the factory method calls the {@link 271451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #needsReload(String, Locale, String, ClassLoader, ResourceBundle, 271551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * long) needsReload} method to determine whether the resource 271651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle needs to be reloaded. If <code>needsReload</code> returns 271751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>true</code>, the cached resource bundle instance is removed 271851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * from the cache. Otherwise, the instance stays in the cache, 271951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * updated with the new TTL value returned by this method. 272051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 272151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>All cached resource bundles are subject to removal from the 272251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cache due to memory constraints of the runtime environment. 272351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returning a large positive value doesn't mean to lock loaded 272451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resource bundles in the cache. 272551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 272651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation returns {@link #TTL_NO_EXPIRATION_CONTROL}. 272751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 272851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 272951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle for which the 273051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * expiration value is specified. 273151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 273251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale of the resource bundle for which the 273351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * expiration value is specified. 273451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the time (0 or a positive millisecond offset from the 273551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cached time) to get loaded bundles expired in the cache, 273651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #TTL_NO_EXPIRATION_CONTROL} to disable the 273751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * expiration control, or {@link #TTL_DONT_CACHE} to disable 273851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * caching. 273951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 274051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> or <code>locale</code> is 274151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>null</code> 274251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 274351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public long getTimeToLive(String baseName, Locale locale) { 274451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseName == null || locale == null) { 274551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 274651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 274751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return TTL_NO_EXPIRATION_CONTROL; 274851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 274951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 275051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 275151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Determines if the expired <code>bundle</code> in the cache needs 275251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to be reloaded based on the loading time given by 275351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>loadTime</code> or some other criteria. The method returns 275451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>true</code> if reloading is required; <code>false</code> 275551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * otherwise. <code>loadTime</code> is a millisecond offset since 275651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <a href="Calendar.html#Epoch"> <code>Calendar</code> 275751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Epoch</a>. 275851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 275951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The calling <code>ResourceBundle.getBundle</code> factory method 276051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * calls this method on the <code>ResourceBundle.Control</code> 276151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instance used for its current invocation, not on the instance 276251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * used in the invocation that originally loaded the resource 276351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle. 276451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 276551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The default implementation compares <code>loadTime</code> and 276651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the last modified time of the source data of the resource 276751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bundle. If it's determined that the source data has been modified 276851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * since <code>loadTime</code>, <code>true</code> is 276951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returned. Otherwise, <code>false</code> is returned. This 277051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementation assumes that the given <code>format</code> is the 277151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same string as its file suffix if it's not one of the default 277251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * formats, <code>"java.class"</code> or 277351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"java.properties"</code>. 277451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 277551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 277651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base bundle name of the resource bundle, a 277751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * fully qualified class name 277851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 277951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which the resource bundle 278051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * should be instantiated 278151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param format 278251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the resource bundle format to be loaded 278351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param loader 278451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the <code>ClassLoader</code> to use to load the bundle 278551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param bundle 278651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the resource bundle instance that has been expired 278751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in the cache 278851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param loadTime 278951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the time when <code>bundle</code> was loaded and put 279051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in the cache 279151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <code>true</code> if the expired bundle needs to be 279251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * reloaded; <code>false</code> otherwise. 279351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 279451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code>, <code>locale</code>, 279551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>format</code>, <code>loader</code>, or 279651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>bundle</code> is <code>null</code> 279751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 279851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean needsReload(String baseName, Locale locale, 279951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String format, ClassLoader loader, 280051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ResourceBundle bundle, long loadTime) { 280151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (bundle == null) { 280251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 280351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 280451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (format.equals("java.class") || format.equals("java.properties")) { 280551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski format = format.substring(5); 280651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 280751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean result = false; 280851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 28097ff253db3117067931e9f249762812de7f3bf694Tobias Thierer String resourceName = toResourceName0(toBundleName(baseName, locale), format); 28107ff253db3117067931e9f249762812de7f3bf694Tobias Thierer if (resourceName == null) { 28117ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return result; 28127ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 281351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski URL url = loader.getResource(resourceName); 281451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (url != null) { 281551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long lastModified = 0; 281651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski URLConnection connection = url.openConnection(); 281751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (connection != null) { 281851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // disable caches to get the correct data 281951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski connection.setUseCaches(false); 282051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (connection instanceof JarURLConnection) { 282151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski JarEntry ent = ((JarURLConnection)connection).getJarEntry(); 282251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (ent != null) { 282351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski lastModified = ent.getTime(); 282451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (lastModified == -1) { 282551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski lastModified = 0; 282651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 282751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 282851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 282951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski lastModified = connection.getLastModified(); 283051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 283151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 283251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = lastModified >= loadTime; 283351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 283451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (NullPointerException npe) { 283551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw npe; 283651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (Exception e) { 283751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // ignore other exceptions 283851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 283951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 284051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 284151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 284251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 284351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Converts the given <code>baseName</code> and <code>locale</code> 284451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to the bundle name. This method is called from the default 284551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementation of the {@link #newBundle(String, Locale, String, 284651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ClassLoader, boolean) newBundle} and {@link #needsReload(String, 284751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Locale, String, ClassLoader, ResourceBundle, long) needsReload} 284851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * methods. 284951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 285051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation returns the following value: 285151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 285251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * baseName + "_" + language + "_" + script + "_" + country + "_" + variant 285351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </pre> 285451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * where <code>language</code>, <code>script</code>, <code>country</code>, 285551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and <code>variant</code> are the language, script, country, and variant 285651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * values of <code>locale</code>, respectively. Final component values that 285751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are empty Strings are omitted along with the preceding '_'. When the 28587ff253db3117067931e9f249762812de7f3bf694Tobias Thierer * script is empty, the script value is omitted along with the preceding '_'. 285951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If all of the values are empty strings, then <code>baseName</code> 286051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is returned. 286151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 286251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>For example, if <code>baseName</code> is 286351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"baseName"</code> and <code>locale</code> is 286451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>Locale("ja", "", "XX")</code>, then 286551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"baseName_ja_ _XX"</code> is returned. If the given 286651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale is <code>Locale("en")</code>, then 286751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"baseName_en"</code> is returned. 286851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 286951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Overriding this method allows applications to use different 287051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * conventions in the organization and packaging of localized 287151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resources. 287251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 287351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param baseName 287451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the base name of the resource bundle, a fully 287551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * qualified class name 287651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 287751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the locale for which a resource bundle should be 287851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * loaded 287951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the bundle name for the resource bundle 288051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 288151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>baseName</code> or <code>locale</code> 288251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is <code>null</code> 288351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 288451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String toBundleName(String baseName, Locale locale) { 288551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (locale == Locale.ROOT) { 288651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return baseName; 288751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 288851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 288951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String language = locale.getLanguage(); 289051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String script = locale.getScript(); 289151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String country = locale.getCountry(); 289251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String variant = locale.getVariant(); 289351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 289451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (language == "" && country == "" && variant == "") { 289551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return baseName; 289651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 289751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 289851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski StringBuilder sb = new StringBuilder(baseName); 289951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append('_'); 290051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (script != "") { 290151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (variant != "") { 290251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(language).append('_').append(script).append('_').append(country).append('_').append(variant); 290351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (country != "") { 290451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(language).append('_').append(script).append('_').append(country); 290551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 290651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(language).append('_').append(script); 290751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 290851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 290951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (variant != "") { 291051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(language).append('_').append(country).append('_').append(variant); 291151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else if (country != "") { 291251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(language).append('_').append(country); 291351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 291451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(language); 291551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 291651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 291751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return sb.toString(); 291851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 291951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 292051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 292151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 292251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Converts the given <code>bundleName</code> to the form required 292351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by the {@link ClassLoader#getResource ClassLoader.getResource} 292451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method by replacing all occurrences of <code>'.'</code> in 292551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>bundleName</code> with <code>'/'</code> and appending a 292651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>'.'</code> and the given file <code>suffix</code>. For 292751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * example, if <code>bundleName</code> is 292851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"foo.bar.MyResources_ja_JP"</code> and <code>suffix</code> 292951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is <code>"properties"</code>, then 293051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <code>"foo/bar/MyResources_ja_JP.properties"</code> is returned. 293151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 293251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param bundleName 293351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the bundle name 293451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param suffix 293551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the file type suffix 293651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the converted resource name 293751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @exception NullPointerException 293851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if <code>bundleName</code> or <code>suffix</code> 293951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is <code>null</code> 294051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 294151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String toResourceName(String bundleName, String suffix) { 294251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski StringBuilder sb = new StringBuilder(bundleName.length() + 1 + suffix.length()); 294351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sb.append(bundleName.replace('.', '/')).append('.').append(suffix); 294451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return sb.toString(); 294551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29467ff253db3117067931e9f249762812de7f3bf694Tobias Thierer 29477ff253db3117067931e9f249762812de7f3bf694Tobias Thierer private String toResourceName0(String bundleName, String suffix) { 29487ff253db3117067931e9f249762812de7f3bf694Tobias Thierer // application protocol check 29497ff253db3117067931e9f249762812de7f3bf694Tobias Thierer if (bundleName.contains("://")) { 29507ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return null; 29517ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } else { 29527ff253db3117067931e9f249762812de7f3bf694Tobias Thierer return toResourceName(bundleName, suffix); 29537ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 29547ff253db3117067931e9f249762812de7f3bf694Tobias Thierer } 295551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 295651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 295751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static class SingleFormatControl extends Control { 295851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final Control PROPERTIES_ONLY 295951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new SingleFormatControl(FORMAT_PROPERTIES); 296051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 296151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final Control CLASS_ONLY 296251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new SingleFormatControl(FORMAT_CLASS); 296351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 296451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final List<String> formats; 296551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 296651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected SingleFormatControl(List<String> formats) { 296751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.formats = formats; 296851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 296951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 297051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public List<String> getFormats(String baseName) { 297151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseName == null) { 297251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 297351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 297451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return formats; 297551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 297651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 297751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 297851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final class NoFallbackControl extends SingleFormatControl { 297951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final Control NO_FALLBACK 298051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new NoFallbackControl(FORMAT_DEFAULT); 298151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 298251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final Control PROPERTIES_ONLY_NO_FALLBACK 298351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new NoFallbackControl(FORMAT_PROPERTIES); 298451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 298551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final Control CLASS_ONLY_NO_FALLBACK 298651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new NoFallbackControl(FORMAT_CLASS); 298751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 298851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected NoFallbackControl(List<String> formats) { 298951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(formats); 299051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 299151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 299251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Locale getFallbackLocale(String baseName, Locale locale) { 299351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (baseName == null || locale == null) { 299451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 299551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 299651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 299751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 299851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 299951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 3000