public class XMLBeanDeclaration extends Object implements BeanDeclaration
An implementation of the BeanDeclaration
interface that is
suitable for XML configuration files.
This class defines the standard layout of a bean declaration in an XML configuration file. Such a declaration must look like the following example fragement:
... <personBean config-class="my.model.PersonBean" lastName="Doe" firstName="John"> <address config-class="my.model.AddressBean" street="21st street 11" zip="1234" city="TestCity"/> </personBean>
The bean declaration can be contained in an arbitrary element. Here it is the
<personBean>
element. In the attributes of this element
there can occur some reserved attributes, which have the following meaning:
config-class
defaultClass
passed to the BeanHelper
class.config-factory
BeanFactory
that should be used for creating the bean.
If it is defined, a factory with this name must have been registered at the
BeanHelper
class. If this attribute is missing, the default
bean factory will be used.config-factoryParam
All further attributes starting with the config-
prefix are
considered as meta data and will be ignored. All other attributes are treated
as properties of the bean to be created, i.e. corresponding setter methods of
the bean will be invoked with the values specified here.
If the bean to be created has also some complex properties (which are itself beans), their values cannot be initialized from attributes. For this purpose nested elements can be used. The example listing shows how an address bean can be initialized. This is done in a nested element whose name must match the name of a property of the enclosing bean declaration. The format of this nested element is exactly the same as for the bean declaration itself, i.e. it can have attributes defining meta data or bean properties and even further nested elements for complex bean properties.
A XMLBeanDeclaration
object is usually created from a
HierarchicalConfiguration
. From this it will derive a
SubnodeConfiguration
, which is used to access the needed
properties. This subnode configuration can be obtained using the
method. All of its properties can
be accessed in the usual way. To ensure that the property keys used by this
class are understood by the configuration, the default expression engine will
be set.
getConfiguration()
Modifier and Type | Field and Description |
---|---|
static String |
ATTR_BEAN_CLASS
Constant for the bean class attribute.
|
static String |
ATTR_BEAN_FACTORY
Constant for the bean factory attribute.
|
static String |
ATTR_FACTORY_PARAM
Constant for the bean factory parameter attribute.
|
static String |
ATTR_PREFIX
Constant for the prefix for reserved attributes.
|
static String |
RESERVED_PREFIX
Constant for the prefix of reserved attributes.
|
Constructor and Description |
---|
XMLBeanDeclaration(HierarchicalConfiguration config)
Creates a new instance of
XMLBeanDeclaration and
initializes it from the given configuration. |
XMLBeanDeclaration(HierarchicalConfiguration config,
String key)
Creates a new instance of
XMLBeanDeclaration and
initializes it from the given configuration. |
XMLBeanDeclaration(HierarchicalConfiguration config,
String key,
boolean optional)
Creates a new instance of
XMLBeanDeclaration and
initializes it from the given configuration. |
XMLBeanDeclaration(SubnodeConfiguration config,
ConfigurationNode node)
Creates a new instance of
XMLBeanDeclaration and
initializes it with the configuration node that contains the bean
declaration. |
Modifier and Type | Method and Description |
---|---|
protected BeanDeclaration |
createBeanDeclaration(ConfigurationNode node)
Creates a new
BeanDeclaration for a child node of the
current configuration node. |
String |
getBeanClassName()
Returns the name of the class of the bean to be created.
|
String |
getBeanFactoryName()
Returns the name of the bean factory.
|
Object |
getBeanFactoryParameter()
Returns a parameter for the bean factory.
|
Map |
getBeanProperties()
Returns a map with the bean's (simple) properties.
|
SubnodeConfiguration |
getConfiguration()
Returns the configuration object this bean declaration is based on.
|
Map |
getNestedBeanDeclarations()
Returns a map with bean declarations for the complex properties of the
bean to be created.
|
ConfigurationNode |
getNode()
Returns the node that contains the bean declaration.
|
protected Object |
interpolate(Object value)
Performs interpolation for the specified value.
|
protected boolean |
isReservedNode(ConfigurationNode nd)
Checks if the specified node is reserved and thus should be ignored.
|
public static final String RESERVED_PREFIX
public static final String ATTR_PREFIX
public static final String ATTR_BEAN_CLASS
public static final String ATTR_BEAN_FACTORY
public static final String ATTR_FACTORY_PARAM
public XMLBeanDeclaration(HierarchicalConfiguration config, String key)
XMLBeanDeclaration
and
initializes it from the given configuration. The passed in key points to
the bean declaration.config
- the configurationkey
- the key to the bean declaration (this key must point to
exactly one bean declaration or a IllegalArgumentException
exception will be thrown)public XMLBeanDeclaration(HierarchicalConfiguration config, String key, boolean optional)
XMLBeanDeclaration
and
initializes it from the given configuration. The passed in key points to
the bean declaration. If the key does not exist and the boolean argument
is true, the declaration is initialized with an empty
configuration. It is possible to create objects from such an empty
declaration if a default class is provided. If the key on the other hand
has multiple values or is undefined and the boolean argument is false,
a IllegalArgumentException
exception will be thrown.config
- the configurationkey
- the key to the bean declarationoptional
- a flag whether this declaration is optional; if set to
true, no exception will be thrown if the passed in key is
undefinedpublic XMLBeanDeclaration(HierarchicalConfiguration config)
XMLBeanDeclaration
and
initializes it from the given configuration. The configuration's root
node must contain the bean declaration.config
- the configuration with the bean declarationpublic XMLBeanDeclaration(SubnodeConfiguration config, ConfigurationNode node)
XMLBeanDeclaration
and
initializes it with the configuration node that contains the bean
declaration.config
- the configurationnode
- the node with the bean declaration.public SubnodeConfiguration getConfiguration()
public ConfigurationNode getNode()
public String getBeanFactoryName()
config-factory
attribute.getBeanFactoryName
in interface BeanDeclaration
public Object getBeanFactoryParameter()
config-factoryParam
attribute.getBeanFactoryParameter
in interface BeanDeclaration
public String getBeanClassName()
config-class
attribute.getBeanClassName
in interface BeanDeclaration
public Map getBeanProperties()
getBeanProperties
in interface BeanDeclaration
public Map getNestedBeanDeclarations()
getNestedBeanDeclarations
in interface BeanDeclaration
protected Object interpolate(Object value)
value
- the value that is to be interpolatedprotected boolean isReservedNode(ConfigurationNode nd)
nd
- the node to be checkedprotected BeanDeclaration createBeanDeclaration(ConfigurationNode node)
BeanDeclaration
for a child node of the
current configuration node. This method is called by
getNestedBeanDeclarations()
for all complex sub properties
detected by this method. Derived classes can hook in if they need a
specific initialization. This base implementation creates a
XMLBeanDeclaration
that is properly initialized from the
passed in node.node
- the child node, for which a BeanDeclaration
is
to be createdBeanDeclaration
for this child nodeCopyright © 2018 JBoss by Red Hat. All rights reserved.