Package nz.org.riskscape.engine.i18n

Class I18nClassLoader

java.lang.Object

java.lang.ClassLoader

nz.org.riskscape.engine.i18n.I18nClassLoader

public class I18nClassLoader
extends ClassLoader

ClassLoader for use with building ResourceBundles that uses an explicit search path for finding resources for use with ResourceBundleControl to control the order with which values from bundles over-write each other.

Maintains a list of class loaders and gives methods for adding new ones at various points to adjust precedence order. Precedence is based on list order where list item 0 is highest to list item n lowest.

Also adds a new getResourcesByPrecedence(String) method to allow the control file to create a MergedPropertiesResourceBundle with application-defined precedence. This allows us to make sure that things like default message can be replaced and redefined by plugins and then again by explicit i18n folders on the user's installed system.

Constructor Summary

Constructors

Constructor	Description
I18nClassLoader()

Method Summary

Modifier and Type	Method	Description
void	append(Object owner, ClassLoader loader)	Inserts a class loader at the end of the list(lowest precedence).
protected Class<?>	findClass(String name)
URL	getResource(String name)
Enumeration<URL>	getResources(String name)
List<URL>	getResourcesByPrecedence(String name)
boolean	insertAfter(Object owner, ClassLoader loader, BiPredicate<Object,ClassLoader> searchMethod)	Similar to but class loader is added after the pair matched by searchMethod.</p>
boolean	insertBefore(Object owner, ClassLoader loader, BiPredicate<Object,ClassLoader> searchMethod)	Inserts a class loader pair before the pair matched by searchMethod.
void	unshift(Object owner, ClassLoader loader)	Inserts a class loader at the head of the list(highest precedence).

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findResource, findResources, findSystemClass, getClassLoadingLock, getDefinedPackage, getDefinedPackages, getName, getPackage, getPackages, getParent, getPlatformClassLoader, getResourceAsStream, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, getUnnamedModule, isRegisteredAsParallelCapable, loadClass, loadClass, registerAsParallelCapable, resolveClass, resources, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

I18nClassLoader

public I18nClassLoader()

Method Details

append

public void append(Object owner,
 ClassLoader loader)

Inserts a class loader at the end of the list(lowest precedence).

Parameters:

owner -

loader -

unshift

public void unshift(Object owner,
 ClassLoader loader)

Inserts a class loader at the head of the list(highest precedence).

Parameters:

owner -

loader -

insertBefore

public boolean insertBefore(Object owner,
 ClassLoader loader,
 BiPredicate<Object,ClassLoader> searchMethod)

Inserts a class loader pair before the pair matched by searchMethod.

If searchMethod does not match any existing class loader pairs then no class loader is inserted and this method returns false.

Parameters:

owner -

loader -

searchMethod - to match pair to insert before

Returns:

true is class loader pair was added, false otherwise.

insertAfter

public boolean insertAfter(Object owner,
 ClassLoader loader,
 BiPredicate<Object,ClassLoader> searchMethod)

Similar to but class loader is added after the pair matched by searchMethod.</p>

findClass

protected Class<?> findClass(String name)
                      throws ClassNotFoundException

Overrides:

findClass in class ClassLoader

Throws:

ClassNotFoundException

getResource

public URL getResource(String name)

Overrides:

getResource in class ClassLoader

getResourcesByPrecedence

public List<URL> getResourcesByPrecedence(String name)

Returns:

a list of resource URLs that match the given name, in order that they were found in the search list. Only returns up to one URL per class-loader.

getResources

public Enumeration<URL> getResources(String name)
                              throws IOException

Overrides:

getResources in class ClassLoader

Throws:

IOException