| java.lang.Object | |
| ↳ | org.springframework.beans.factory.xml.BeanDefinitionParserDelegate |
Class Overview
Stateful delegate class used to parse XML bean definitions.
Intended for use by both the main parser and any extension
BeanDefinitionParsers or
BeanDefinitionDecorators.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| logger | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create a new BeanDefinitionParserDelegate associated with the
supplied
XmlReaderContext and Environment. | |||||||||||
This constructor is deprecated.
since Spring 3.1 in favor of
BeanDefinitionParserDelegate(XmlReaderContext, Environment)
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Return any patterns provided in the 'default-autowire-candidates'
attribute of the top-level
<beans/> element. | |||||||||||
Return the default settings for bean definitions as indicated within
the attributes of the top-level
<beans/> element. | |||||||||||
Return the defaults definition object, or
null if the
defaults have been initialized yet. | |||||||||||
Get the
Environment associated with this helper instance. | |||||||||||
Ges the local name for the supplied
Node. | |||||||||||
Get the namespace URI for the supplied node.
| |||||||||||
Get the
XmlReaderContext associated with this helper instance. | |||||||||||
Initialize the default lazy-init, autowire, dependency check settings,
init-method, destroy-method and merge settings.
| |||||||||||
This method is deprecated.
in Spring 3.1 in favor of
initDefaults(Element, BeanDefinitionParserDelegate)
| |||||||||||
Determine whether the name of the supplied node is equal to the supplied name.
| |||||||||||
Parse an array element.
| |||||||||||
Apply the attributes of the given bean element to the given bean * definition.
| |||||||||||
Parse the bean definition itself, without regard to name or aliases.
| |||||||||||
Parses the supplied
<bean> element. | |||||||||||
Parses the supplied
<bean> element. | |||||||||||
Parse a constructor-arg element.
| |||||||||||
Parse constructor-arg sub-elements of the given bean element.
| |||||||||||
Return a typed String value Object for the given 'idref' element.
| |||||||||||
Parse a list element.
| |||||||||||
Parse lookup-override sub-elements of the given bean element.
| |||||||||||
Parse a map element.
| |||||||||||
Parse the merge attribute of a collection element, if any.
| |||||||||||
Parse a property element.
| |||||||||||
Parse property sub-elements of the given bean element.
| |||||||||||
Parse a value, ref or collection sub-element of a property or
constructor-arg element.
| |||||||||||
Get the value of a property element.
| |||||||||||
Parse a props element.
| |||||||||||
Parse a qualifier element.
| |||||||||||
Parse qualifier sub-elements of the given bean element.
| |||||||||||
Parse replaced-method sub-elements of the given bean element.
| |||||||||||
Parse a set element.
| |||||||||||
Return a typed String value Object for the given value element.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Build a typed String value Object for the given raw value.
| |||||||||||
Build a typed String value Object for the given raw value.
| |||||||||||
Validate that the specified bean name and aliases have not been used already
within the current level of beans element nesting.
| |||||||||||
Create a bean definition for the given class name and parent name.
| |||||||||||
Report an error with the given message for the given source element.
| |||||||||||
Report an error with the given message for the given source element.
| |||||||||||
Report an error with the given message for the given source element.
| |||||||||||
Invoke the
SourceExtractor to pull the
source metadata from the supplied Element. | |||||||||||
Parse a key sub-element of a map element.
| |||||||||||
Populate the given DocumentDefaultsDefinition instance with the default lazy-init,
autowire, dependency check settings, init-method, destroy-method and merge settings.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String AUTOWIRE_CANDIDATE_ATTRIBUTE
public static final String AUTOWIRE_CONSTRUCTOR_VALUE
public static final String BEANS_NAMESPACE_URI
public static final String CONSTRUCTOR_ARG_ELEMENT
public static final String DEFAULT_AUTOWIRE_ATTRIBUTE
public static final String DEFAULT_AUTOWIRE_CANDIDATES_ATTRIBUTE
public static final String DEFAULT_DEPENDENCY_CHECK_ATTRIBUTE
public static final String DEFAULT_DESTROY_METHOD_ATTRIBUTE
public static final String DEFAULT_INIT_METHOD_ATTRIBUTE
public static final String DEFAULT_LAZY_INIT_ATTRIBUTE
public static final String DEFAULT_MERGE_ATTRIBUTE
public static final String DEPENDENCY_CHECK_ALL_ATTRIBUTE_VALUE
public static final String DEPENDENCY_CHECK_ATTRIBUTE
public static final String DEPENDENCY_CHECK_OBJECTS_ATTRIBUTE_VALUE
public static final String DEPENDENCY_CHECK_SIMPLE_ATTRIBUTE_VALUE
public static final String DESTROY_METHOD_ATTRIBUTE
public static final String FACTORY_METHOD_ATTRIBUTE
public static final String QUALIFIER_ATTRIBUTE_ELEMENT
public static final String REPLACED_METHOD_ELEMENT
public static final String TRUE_VALUE
Value of a T/F attribute that represents true. Anything else represents false. Case seNsItive.
Fields
Public Constructors
public BeanDefinitionParserDelegate (XmlReaderContext readerContext, Environment environment)
Create a new BeanDefinitionParserDelegate associated with the
supplied XmlReaderContext and Environment.
public BeanDefinitionParserDelegate (XmlReaderContext readerContext)
This constructor is deprecated.
since Spring 3.1 in favor of
BeanDefinitionParserDelegate(XmlReaderContext, Environment)
Create a new BeanDefinitionParserDelegate associated with the
supplied XmlReaderContext and a new DefaultEnvironment.
Public Methods
public BeanDefinitionHolder decorateBeanDefinitionIfRequired (Element ele, BeanDefinitionHolder definitionHolder, BeanDefinition containingBd)
public BeanDefinitionHolder decorateBeanDefinitionIfRequired (Element ele, BeanDefinitionHolder definitionHolder)
public String[] getAutowireCandidatePatterns ()
Return any patterns provided in the 'default-autowire-candidates'
attribute of the top-level <beans/> element.
public BeanDefinitionDefaults getBeanDefinitionDefaults ()
Return the default settings for bean definitions as indicated within
the attributes of the top-level <beans/> element.
public DocumentDefaultsDefinition getDefaults ()
Return the defaults definition object, or null if the
defaults have been initialized yet.
public final Environment getEnvironment ()
Get the Environment associated with this helper instance.
public String getLocalName (Node node)
Ges the local name for the supplied Node. The default implementation calls getLocalName().
Subclasses may override the default implementation to provide a different mechanism for getting the local name.
Parameters
| node | the Node
|
|---|
public String getNamespaceURI (Node node)
Get the namespace URI for the supplied node. The default implementation uses getNamespaceURI().
Subclasses may override the default implementation to provide a different namespace identification mechanism.
Parameters
| node | the node |
|---|
public final XmlReaderContext getReaderContext ()
Get the XmlReaderContext associated with this helper instance.
public void initDefaults (Element root, BeanDefinitionParserDelegate parent)
Initialize the default lazy-init, autowire, dependency check settings, init-method, destroy-method and merge settings. Support nested 'beans' element use cases by falling back to the given parent in case the defaults are not explicitly set locally.
public void initDefaults (Element root)
This method is deprecated.
in Spring 3.1 in favor of
initDefaults(Element, BeanDefinitionParserDelegate)
Initialize the default settings assuming a null parent delegate.
public boolean nodeNameEquals (Node node, String desiredName)
Determine whether the name of the supplied node is equal to the supplied name.
The default implementation checks the supplied desired name against both
getNodeName() and getLocalName().
Subclasses may override the default implementation to provide a different mechanism for comparing node names.
Parameters
| node | the node to compare |
|---|---|
| desiredName | the name to check for |
public Object parseArrayElement (Element arrayEle, BeanDefinition bd)
Parse an array element.
public AbstractBeanDefinition parseBeanDefinitionAttributes (Element ele, String beanName, BeanDefinition containingBean, AbstractBeanDefinition bd)
Apply the attributes of the given bean element to the given bean * definition.
Parameters
| ele | bean declaration element |
|---|---|
| beanName | bean name |
| containingBean | containing bean definition |
Returns
- a bean definition initialized according to the bean element attributes
public AbstractBeanDefinition parseBeanDefinitionElement (Element ele, String beanName, BeanDefinition containingBean)
Parse the bean definition itself, without regard to name or aliases. May return
null if problems occured during the parse of the bean definition.
public BeanDefinitionHolder parseBeanDefinitionElement (Element ele, BeanDefinition containingBean)
Parses the supplied <bean> element. May return null
if there were errors during parse. Errors are reported to the
ProblemReporter.
public BeanDefinitionHolder parseBeanDefinitionElement (Element ele)
Parses the supplied <bean> element. May return null
if there were errors during parse. Errors are reported to the
ProblemReporter.
public void parseConstructorArgElement (Element ele, BeanDefinition bd)
Parse a constructor-arg element.
public void parseConstructorArgElements (Element beanEle, BeanDefinition bd)
Parse constructor-arg sub-elements of the given bean element.
public BeanDefinition parseCustomElement (Element ele, BeanDefinition containingBd)
public Object parseIdRefElement (Element ele)
Return a typed String value Object for the given 'idref' element.
public List parseListElement (Element collectionEle, BeanDefinition bd)
Parse a list element.
public void parseLookupOverrideSubElements (Element beanEle, MethodOverrides overrides)
Parse lookup-override sub-elements of the given bean element.
public Map parseMapElement (Element mapEle, BeanDefinition bd)
Parse a map element.
public boolean parseMergeAttribute (Element collectionElement)
Parse the merge attribute of a collection element, if any.
public void parseMetaElements (Element ele, BeanMetadataAttributeAccessor attributeAccessor)
public void parsePropertyElement (Element ele, BeanDefinition bd)
Parse a property element.
public void parsePropertyElements (Element beanEle, BeanDefinition bd)
Parse property sub-elements of the given bean element.
public Object parsePropertySubElement (Element ele, BeanDefinition bd, String defaultValueType)
Parse a value, ref or collection sub-element of a property or constructor-arg element.
Parameters
| ele | subelement of property element; we don't know which yet |
|---|---|
| defaultValueType | the default type (class name) for any
<value> tag that might be created
|
public Object parsePropertyValue (Element ele, BeanDefinition bd, String propertyName)
Get the value of a property element. May be a list etc. Also used for constructor arguments, "propertyName" being null in this case.
public void parseQualifierElement (Element ele, AbstractBeanDefinition bd)
Parse a qualifier element.
public void parseQualifierElements (Element beanEle, AbstractBeanDefinition bd)
Parse qualifier sub-elements of the given bean element.
public void parseReplacedMethodSubElements (Element beanEle, MethodOverrides overrides)
Parse replaced-method sub-elements of the given bean element.
public Set parseSetElement (Element collectionEle, BeanDefinition bd)
Parse a set element.
public Object parseValueElement (Element ele, String defaultTypeName)
Return a typed String value Object for the given value element.
Protected Methods
protected TypedStringValue buildTypedStringValue (String value, String targetTypeName)
protected final Object buildTypedStringValueForMap (String value, String defaultTypeName, Element entryEle)
Build a typed String value Object for the given raw value.
See Also
protected void checkNameUniqueness (String beanName, List<String> aliases, Element beanElement)
Validate that the specified bean name and aliases have not been used already within the current level of beans element nesting.
protected AbstractBeanDefinition createBeanDefinition (String className, String parentName)
Create a bean definition for the given class name and parent name.
Parameters
| className | the name of the bean class |
|---|---|
| parentName | the name of the bean's parent bean |
Returns
- the newly created bean definition
Throws
| ClassNotFoundException | if bean class resolution was attempted but failed |
|---|
protected void error (String message, Element source)
Report an error with the given message for the given source element.
protected void error (String message, Node source)
Report an error with the given message for the given source element.
protected void error (String message, Element source, Throwable cause)
Report an error with the given message for the given source element.
protected Object extractSource (Element ele)
Invoke the SourceExtractor to pull the
source metadata from the supplied Element.
protected void parseCollectionElements (NodeList elementNodes, Collection<Object> target, BeanDefinition bd, String defaultElementType)
protected Object parseKeyElement (Element keyEle, BeanDefinition bd, String defaultKeyTypeName)
Parse a key sub-element of a map element.
protected void populateDefaults (DocumentDefaultsDefinition defaults, DocumentDefaultsDefinition parentDefaults, Element root)
Populate the given DocumentDefaultsDefinition instance with the default lazy-init,
autowire, dependency check settings, init-method, destroy-method and merge settings.
Support nested 'beans' element use cases by falling back to
Parameters
| defaults | the parent BeanDefinitionParserDelegate (if any) defaults to fall back to |
|---|---|
| root | the root element of the current bean definition document (or nested beans element) |