Top Description Methods
org.springframework.beans.factory.xml

public Interface BeanDefinitionParser

Known Direct Implementers
org.springframework.beans.factory.xml.AbstractBeanDefinitionParser
Imports
org.w3c.dom.Element, org.springframework.beans.factory.config.BeanDefinition, org.springframework.lang.Nullable

Interface used by the DefaultBeanDefinitionDocumentReader to handle custom, top-level (directly under <beans/>) tags.

Implementations are free to turn the metadata in the custom tag into as many BeanDefinitions as required.

The parser locates a BeanDefinitionParser from the associated NamespaceHandler for the namespace in which the custom tag resides.

Author
Rob Harrop
Since
2.0
See Also
NamespaceHandler, AbstractBeanDefinitionParser

Method Summary

Modifier and TypeMethod and Description
public BeanDefinition

Returns:

the primary BeanDefinition
parse
(Element
the element that is to be parsed into one or more BeanDefinitions
element
,
ParserContext
the object encapsulating the current state of the parsing process; provides access to a org.springframework.beans.factory.support.BeanDefinitionRegistry
parserContext
)

Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.

Method Detail

parseback to summary
public BeanDefinition parse(Element element, ParserContext parserContext)

Parse the specified Element and register the resulting BeanDefinition(s) with the BeanDefinitionRegistry embedded in the supplied ParserContext.

Implementations must return the primary BeanDefinition that results from the parse if they will ever be used in a nested fashion (for example as an inner tag in a <property/> tag). Implementations may return null if they will not be used in a nested fashion.

Parameters
element:Element

the element that is to be parsed into one or more BeanDefinitions

parserContext:ParserContext

the object encapsulating the current state of the parsing process; provides access to a org.springframework.beans.factory.support.BeanDefinitionRegistry

Returns:BeanDefinition

the primary BeanDefinition

Annotations
@Nullable