1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package org.ietf.ldap;
import java.util.*;
import java.io.*;
/**
* This class represents a locale-specific resource for a property file.
* It retrieves the property file for the given base name including the
* absolute path name and locale. The property file has to be located in the
* CLASSPATH and the property file's suffix is .props.
* <p>
* If the specified locale is en and us and the base name of the file is
* netscape/ldap/errors/ErrorCodes, then the class loader will search for
* the file in the following order:
* <pre>
*
* ErrorCodes_en_us.properties
* ErrorCodes_en.properties
* ErrorCodes.properties
*
* </pre>
* @see java.util.Locale
*/
class LDAPResourceBundle implements java.io.Serializable {
static final long serialVersionUID = -5903986665461157980L;
private static final boolean _debug = false;
private static final String _suffix = ".properties";
private static final String _locale_separator = "_";
/**
* Return the property resource bundle according to the base name of the
* property file and the locale. The class loader will find the closest match
* with the given locale.
* @return the property resource bundle.
* @exception IOException Gets thrown when failed to open the resource
* bundle file.
*/
static PropertyResourceBundle getBundle( String baseName )
throws IOException {
return getBundle( baseName, Locale.getDefault() );
}
/**
* Return the property resource bundle according to the base name of the
* property file and the locale. The class loader will find the closest match
* with the given locale.
* @param baseName the base name of the property file. The base name contains
* no locale context and no . suffix.
* @param l the locale
* @return the property resource bundle.
* @exception IOException Gets thrown when failed to create a property
* resource
*/
static PropertyResourceBundle getBundle( String baseName, Locale l )
throws IOException {
String localeStr = _locale_separator + l.toString();
InputStream fin = null;
while ( true ) {
if ( (fin = getStream(baseName, localeStr)) != null ) {
PropertyResourceBundle p = new PropertyResourceBundle( fin );
return p;
} else {
int index = localeStr.lastIndexOf( _locale_separator );
if ( index == -1 ) {
printDebug( "File " + baseName + localeStr + _suffix +
" not found" );
return null;
} else {
localeStr = localeStr.substring( 0, index );
}
}
}
}
/**
* Constructs the whole absolute path name of a property file and retrieves
* an input stream on the file.
* @param baseName the base name of the property file. The base name contains
* no locale context and no . suffix.
* @param the locale string to insert into the file name
* @return the input stream of the property file.
*/
private static InputStream getStream( String baseName, String locale ) {
String fStr = baseName + locale + _suffix;
return ClassLoader.getSystemResourceAsStream( fStr );
}
/**
* Prints debug messages if the debug mode is on.
* @param str the message that is printed
*/
private static void printDebug(String str) {
if ( _debug ) {
System.out.println( str );
}
}
}
|