net.sf.mmm.util.nls.base

Class AbstractNlsBundleFactory

java.lang.Object

net.sf.mmm.util.component.base.AbstractComponent

net.sf.mmm.util.nls.base.AbstractNlsBundleFactory

All Implemented Interfaces:

NlsBundleFactory

Direct Known Subclasses:

NlsBundleFactoryImpl

public abstract class AbstractNlsBundleFactory
extends AbstractComponent
implements NlsBundleFactory

This is the abstract base implementation of NlsBundleFactory.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractNlsBundleFactory.NlsBundleDescriptor Interface describing an NlsBundle interface.
protected class	AbstractNlsBundleFactory.NlsBundleInvocationHandler This inner class is an InvocationHandler for the dynamic NlsBundle instance.
protected static class	AbstractNlsBundleFactory.NlsBundleMethodInfo This inner class holds all the information to be cached for a NlsBundle-method.

Field Summary

Fields

Modifier and Type	Field and Description
private List<AbstractNlsBundleFactory.NlsBundleInvocationHandler>	bundleDescriptors
private Map<Class<? extends NlsBundle>,NlsBundle>	bundleMap
private ClassLoader	classLoader
private ClasspathScanner	classpathScanner
private static Object[]	FAKE_ARGS An internal trick used for optimization to avoid reflective parameter lookup.
private NlsMessageFactory	messageFactory
static String	METHOD_NAME_LOOKUP The name of the method NlsBundleWithLookup.getMessage(String, Map).
private static Pattern	NLS_BUNDLE_CLASS_NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
AbstractNlsBundleFactory() The constructor.
AbstractNlsBundleFactory(ClassLoader classLoader) The constructor.

Method Summary

Modifier and Type	Method and Description
<BUNDLE extends NlsBundle> BUNDLE	createBundle(Class<BUNDLE> bundleInterface) This method dynamically creates an instance for the given bundleInterface.
private <BUNDLE extends NlsBundle> BUNDLE	createBundleInternal(Class<BUNDLE> bundleInterface)
protected InvocationHandler	createHandler(Class<? extends NlsBundle> bundleInterface) This method creates a new InvocationHandler for the given bundleInterface.
protected void	doInitialize() This method performs the actual initialization.
protected void	doInitialized() This method is invoked at the end of the actual initialization.
protected NlsBundleOptions	getBundleOptions(Class<? extends NlsBundle> bundleInterface) This method gets the NlsBundleOptions for the given bundleInterface.
ClasspathScanner	getClasspathScanner()
protected NlsMessageFactory	getMessageFactory()
Collection<? extends AbstractNlsBundleFactory.NlsBundleDescriptor>	getNlsBundleDescriptors()
private List<AbstractNlsBundleFactory.NlsBundleInvocationHandler>	populateNlsBundleDescriptors()
void	setClasspathScanner(ClasspathScanner classpathScanner)
void	setMessageFactory(NlsMessageFactory messageFactory)

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

getInitializationState, initialize

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_NAME_LOOKUP

public static final String METHOD_NAME_LOOKUP

The name of the method NlsBundleWithLookup.getMessage(String, Map).

See Also:

Constant Field Values

FAKE_ARGS

private static final Object[] FAKE_ARGS

An internal trick used for optimization to avoid reflective parameter lookup.

NLS_BUNDLE_CLASS_NAME_PATTERN

private static final Pattern NLS_BUNDLE_CLASS_NAME_PATTERN

classLoader

private final ClassLoader classLoader

bundleMap

private final Map<Class<? extends NlsBundle>,NlsBundle> bundleMap

messageFactory

private NlsMessageFactory messageFactory

classpathScanner

private ClasspathScanner classpathScanner

bundleDescriptors

private List<AbstractNlsBundleFactory.NlsBundleInvocationHandler> bundleDescriptors

Constructor Detail

AbstractNlsBundleFactory

public AbstractNlsBundleFactory()

The constructor.

AbstractNlsBundleFactory

public AbstractNlsBundleFactory(ClassLoader classLoader)

The constructor.

Parameters:

classLoader - is the ClassLoader to use.

Method Detail

doInitialize

protected void doInitialize()

Description copied from class: AbstractComponent

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractComponent

doInitialized

protected void doInitialized()

Description copied from class: AbstractComponent

This method is invoked at the end of the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time after AbstractComponent.doInitialize() is completed and initialization-state has changed to initialized.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialized().

Overrides:

doInitialized in class AbstractComponent

getMessageFactory

protected NlsMessageFactory getMessageFactory()

Returns:

the NlsMessageFactory.

setMessageFactory

@Inject
public void setMessageFactory(NlsMessageFactory messageFactory)

Parameters:

messageFactory - the NlsMessageFactory to Inject.

getClasspathScanner

public ClasspathScanner getClasspathScanner()

Returns:

the classpathScanner

setClasspathScanner

@Inject
public void setClasspathScanner(ClasspathScanner classpathScanner)

Parameters:

classpathScanner - the ClasspathScanner to Inject.

createBundle

public <BUNDLE extends NlsBundle> BUNDLE createBundle(Class<BUNDLE> bundleInterface)

Description copied from interface: NlsBundleFactory

This method dynamically creates an instance for the given bundleInterface.

Specified by:

createBundle in interface NlsBundleFactory

Type Parameters:

BUNDLE - is the generic type of the requested NlsBundle.

Parameters:

bundleInterface - the interface of the requested NlsBundle. Has to be a sub-interface of NlsBundle with according methods.

Returns:

an instance of the requested NlsBundle interface.

createBundleInternal

private <BUNDLE extends NlsBundle> BUNDLE createBundleInternal(Class<BUNDLE> bundleInterface)

getBundleOptions

protected NlsBundleOptions getBundleOptions(Class<? extends NlsBundle> bundleInterface)

This method gets the NlsBundleOptions for the given bundleInterface. If NOT present a default instance is returned.

Parameters:

bundleInterface - is the Class reflecting the NlsBundle interface.

Returns:

the annotated NlsBundleOptions or the default if bundleInterface is NOT annotated accordingly.

createHandler

protected InvocationHandler createHandler(Class<? extends NlsBundle> bundleInterface)

This method creates a new InvocationHandler for the given bundleInterface.

Parameters:

bundleInterface - is the Class reflecting the NlsBundle interface.

Returns:

the InvocationHandler for the given bundleInterface.

getNlsBundleDescriptors

public Collection<? extends AbstractNlsBundleFactory.NlsBundleDescriptor> getNlsBundleDescriptors()

Returns:

a Collection of AbstractNlsBundleFactory.NlsBundleDescriptors for all NlsBundle-interfaces on the classpath following the suggested naming convention NlsBundle*Root.

populateNlsBundleDescriptors

private List<AbstractNlsBundleFactory.NlsBundleInvocationHandler> populateNlsBundleDescriptors()