| java.lang.Object
 org.apache.commons.configuration.beanutils.BeanHelper
| BeanHelper | | public class BeanHelper (Code) | |
A helper class for creating bean instances that are defined in configuration
files.
This class provides static utility methods related to bean creation
operations. These methods simplify such operations because a client need not
deal with all involved interfaces. Usually, if a bean declaration has already
been obtained, a single method call is necessary to create a new bean
instance.
This class also supports the registration of custom bean factories.
Implementations of the
BeanFactory interface can be
registered under a symbolic name using the registerBeanFactory()
method. In the configuration file the name of the bean factory can be
specified in the bean declaration. Then this factory will be used to create
the bean.
since:
1.3
author:
Oliver Heger
version:
$Id: BeanHelper.java 508152 2007-02-15 21:16:37Z oheger $ |
| createBean | | public static Object createBean(BeanDeclaration data, Class defaultClass, Object param) throws ConfigurationRuntimeException(Code) | | The main method for creating and initializing beans from a configuration.
This method will return an initialized instance of the bean class
specified in the passed in bean declaration. If this declaration does not
contain the class of the bean, the passed in default class will be used.
From the bean declaration the factory to be used for creating the bean is
queried. The declaration may here return null, then a default
factory is used. This factory is then invoked to perform the create
operation.
Parameters:
data - the bean declaration
Parameters:
defaultClass - the default class to use
Parameters:
param - an additional parameter that will be passed to the beanfactory; some factories may support parameters and behave differentdepending on the value passed in here the new bean
throws:
ConfigurationRuntimeException - if an error occurs |
| deregisterBeanFactory | | public static BeanFactory deregisterBeanFactory(String name)(Code) | | Deregisters the bean factory with the given name. After that this factory
cannot be used any longer.
Parameters:
name - the name of the factory to be deregistered the factory that was registered under this name; null ifthere was no such factory |
| getDefaultBeanFactory | | public static BeanFactory getDefaultBeanFactory()(Code) | | Returns the default bean factory.
the default bean factory |
| initBean | | public static void initBean(Object bean, BeanDeclaration data) throws ConfigurationRuntimeException(Code) | | Initializes the passed in bean. This method will obtain all the bean's
properties that are defined in the passed in bean declaration. These
properties will be set on the bean. If necessary, further beans will be
created recursively.
Parameters:
bean - the bean to be initialized
Parameters:
data - the bean declaration
throws:
ConfigurationRuntimeException - if a property cannot be set |
| loadClass | | static Class loadClass(String name, Class callingClass) throws ClassNotFoundException(Code) | | Returns a java.lang.Class object for the specified name.
This method and the helper method it invokes are very similar to code
extracted from the ClassLoaderUtils class of Commons
Jelly. It should be replaced if Commons Lang provides a generic version.
Parameters:
name - the name of the class to be loaded
Parameters:
callingClass - the calling class the class object for the specified name
throws:
ClassNotFoundException - if the class cannot be loaded |
| registerBeanFactory | | public static void registerBeanFactory(String name, BeanFactory factory)(Code) | | Register a bean factory under a symbolic name. This factory object can
then be specified in bean declarations with the effect that this factory
will be used to obtain an instance for the corresponding bean
declaration.
Parameters:
name - the name of the factory
Parameters:
factory - the factory to be registered |
| registeredFactoryNames | | public static Set registeredFactoryNames()(Code) | | Returns a set with the names of all currently registered bean factories.
a set with the names of the registered bean factories |
| setDefaultBeanFactory | | public static void setDefaultBeanFactory(BeanFactory factory)(Code) | | Sets the default bean factory. This factory will be used for all create
operations, for which no special factory is provided in the bean
declaration.
Parameters:
factory - the default bean factory (must not be null) |
|
|