Read ResourceBundles with custom encodings
/*
* This file is part of aion-emu <aion-emu.com>.
*
* aion-emu is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* aion-emu is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with aion-emu. If not, see <http://www.gnu.org/licenses/>.
*/
//package com.aionemu.commons.utils.i18n;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.net.URLConnection;
import java.security.AccessController;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.Locale;
import java.util.PropertyResourceBundle;
import java.util.ResourceBundle;
/**
* This class allows us to read ResourceBundles with custom encodings, so we don't have write \\uxxxx symbols and use
* utilities like native2ascii to convert files.
* <p/>
* <br>
*
* Usage: For instance we want to load resource bundle "test" from current deirectory and use english locale. If locale
* not found, we will use default file (and ignore default locale).
*
* <pre>
* URLClassLoader loader = new URLClassLoader(new URL[] { new File(".").toURI().toURL() });
*
* ResourceBundle rb = ResourceBundle.getBundle("test", Locale.ENGLISH, loader, new ResourceBundleControl("UTF-8"));
*
* // English locale not found, use default
* if(!rb.getLocale().equals(Locale.ENGLISH))
* {
* rb = ResourceBundle.getBundle("test", Locale.ROOT, loader, new ResourceBundleControl("UTF-8"));
* }
*
* System.out.println(rb.getString("test"));
* </pre>
*
* @author SoulKeeper
*/
public class ResourceBundleControl extends ResourceBundle.Control
{
/**
* Encoding which will be used to read resource bundle, by defaults it's 8859_1
*/
private String encoding = "UTF-8";
/**
* Just empty default constructor
*/
public ResourceBundleControl()
{
}
/**
* This constructor allows to set encoding that will be used while reading resource bundle
*
* @param encoding
* encoding to use
*/
public ResourceBundleControl(String encoding)
{
this.encoding = encoding;
}
/**
* This code is just copy-paste with usage {@link java.io.Reader} instead of {@link java.io.InputStream} to read
* properties.<br>
* <br>
*
* {@inheritDoc}
*/
@Override
public ResourceBundle newBundle(String baseName, Locale locale, String format, ClassLoader loader, boolean reload) throws IllegalAccessException,
InstantiationException, IOException
{
String bundleName = toBundleName(baseName, locale);
ResourceBundle bundle = null;
if (format.equals("java.class"))
{
try
{
@SuppressWarnings(
{ "unchecked" })
Class<? extends ResourceBundle> bundleClass = (Class<? extends ResourceBundle>) loader.loadClass(bundleName);
// If the class isn't a ResourceBundle subclass, throw a
// ClassCastException.
if (ResourceBundle.class.isAssignableFrom(bundleClass))
{
bundle = bundleClass.newInstance();
}
else
{
throw new ClassCastException(bundleClass.getName() + " cannot be cast to ResourceBundle");
}
}
catch (ClassNotFoundException ignored)
{
}
}
else if (format.equals("java.properties"))
{
final String resourceName = toResourceName(bundleName, "properties");
final ClassLoader classLoader = loader;
final boolean reloadFlag = reload;
InputStreamReader isr = null;
InputStream stream;
try
{
stream = AccessController.doPrivileged(new PrivilegedExceptionAction<InputStream>()
{
@Override
public InputStream run() throws IOException
{
InputStream is = null;
if (reloadFlag)
{
URL url = classLoader.getResource(resourceName);
if (url != null)
{
URLConnection connection = url.openConnection();
if (connection != null)
{
// Disable caches to get fresh data for
// reloading.
connection.setUseCaches(false);
is = connection.getInputStream();
}
}
}
else
{
is = classLoader.getResourceAsStream(resourceName);
}
return is;
}
});
if (stream != null)
{
isr = new InputStreamReader(stream, encoding);
}
}
catch (PrivilegedActionException e)
{
throw (IOException) e.getException();
}
if (isr != null)
{
try
{
bundle = new PropertyResourceBundle(isr);
}
finally
{
isr.close();
}
}
}
else
{
throw new IllegalArgumentException("unknown format: " + format);
}
return bundle;
}
/**
* Returns encoding that will be used to read .properties resource bundles
*
* @return encoding
*/
public String getEncoding()
{
return encoding;
}
/**
* Sets the encoding that will be used to read properties resource bundles
*
* @param encoding
* encoding that will be used for properties
*/
public void setEncoding(String encoding)
{
this.encoding = encoding;
}
}
Related examples in the same category
