Spring Framework 6.1.4 · org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

Modifier and Type	Field and Description
public static final String	ID_ATTRIBUTE Constant for the "id" attribute.
public static final String	NAME_ATTRIBUTE Constant for the "name" attribute.

Access	Constructor and Description
public	AbstractBeanDefinitionParser()

Method Summary

Modifier and Type	Method and Description
public final 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) Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Parse the specified `Element` and register the resulting `BeanDefinition(s)` with the `BeanDefinitionRegistry` embedded in the supplied `ParserContext`.
protected abstract AbstractBeanDefinition	Returns: the primary `BeanDefinition` resulting from the parsing of the supplied `Element` parseInternal(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) Central template method to actually parse the supplied `Element` into one or more `BeanDefinitions`.
protected void	postProcessComponentDefinition(BeanComponentDefinition the `BeanComponentDefinition` that is to be processed componentDefinition) Hook method called after the primary parsing of a `BeanComponentDefinition` but before the `BeanComponentDefinition` has been registered with a `org.springframework.beans.factory.support.BeanDefinitionRegistry`.
protected void	registerBeanDefinition(BeanDefinitionHolder the bean definition to be registered definition, BeanDefinitionRegistry the registry that the bean is to be registered with registry) Register the supplied `bean` with the supplied `registry`.
protected String	Returns: the resolved id resolveId(Element the element that the bean definition has been built from element, AbstractBeanDefinition the bean definition to be registered definition, ParserContext the object encapsulating the current state of the parsing process; provides access to a `org.springframework.beans.factory.support.BeanDefinitionRegistry` parserContext) Resolve the ID for the supplied `BeanDefinition`.
protected boolean	Returns: `true` in order to fire a component registration event after parsing the bean definition; `false` to suppress the event shouldFireEvents() Determine whether this parser is supposed to fire a `org.springframework.beans.factory.parsing.BeanComponentDefinition` event after parsing the bean definition.
protected boolean	Returns: whether the parser should always generate an id shouldGenerateId() Should an ID be generated instead of read from the passed in `Element`?
protected boolean	Returns: whether the parser should generate an id if no id was specified shouldGenerateIdAsFallback() Should an ID be generated instead if the passed in `Element` does not specify an "id" attribute explicitly?
protected boolean	Returns: whether the parser should evaluate the "name" attribute as aliases shouldParseNameAsAliases() Determine whether the element's "name" attribute should get parsed as bean definition aliases, i.e. alternative bean definition names.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ID_ATTRIBUTE	back to summary
public static final String ID_ATTRIBUTE Constant for the "id" attribute.

NAME_ATTRIBUTE	back to summary
public static final String NAME_ATTRIBUTE Constant for the "name" attribute.

AbstractBeanDefinitionParser	back to summary
public AbstractBeanDefinitionParser()

Method Detail

parse back to summary

parse	back to summary
public final BeanDefinition parse(Element element, ParserContext parserContext) Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse. Doc from org.springframework.beans.factory.xml.BeanDefinitionParser.parse. 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 @Override @Nullable

public final BeanDefinition parse(Element element, ParserContext parserContext)

Implements org.springframework.beans.factory.xml.BeanDefinitionParser.parse.

Doc from org.springframework.beans.factory.xml.BeanDefinitionParser.parse.

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

@Override
@Nullable

parseInternal back to summary

parseInternal	back to summary
protected abstract AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext) Central template method to actually parse the supplied `Element` into one or more `BeanDefinitions`. 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:AbstractBeanDefinition the primary `BeanDefinition` resulting from the parsing of the supplied `Element` Annotations @Nullable See Also `parse(org.w3c.dom.Element, ParserContext)`, `postProcessComponentDefinition(org.springframework.beans.factory.parsing.BeanComponentDefinition)`

protected abstract AbstractBeanDefinition parseInternal(Element element, ParserContext parserContext)

Central template method to actually parse the supplied Element into one or more BeanDefinitions.

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:AbstractBeanDefinition

the primary BeanDefinition resulting from the parsing of the supplied Element

Annotations

@Nullable

postProcessComponentDefinition back to summary

postProcessComponentDefinition	back to summary
protected void postProcessComponentDefinition(BeanComponentDefinition componentDefinition) Hook method called after the primary parsing of a `BeanComponentDefinition` but before the `BeanComponentDefinition` has been registered with a `org.springframework.beans.factory.support.BeanDefinitionRegistry`. Derived classes can override this method to supply any custom logic that is to be executed after all the parsing is finished. The default implementation is a no-op. Parameters componentDefinition:BeanComponentDefinition the `BeanComponentDefinition` that is to be processed

protected void postProcessComponentDefinition(BeanComponentDefinition componentDefinition)

Hook method called after the primary parsing of a BeanComponentDefinition but before the BeanComponentDefinition has been registered with a org.springframework.beans.factory.support.BeanDefinitionRegistry.

Derived classes can override this method to supply any custom logic that is to be executed after all the parsing is finished.

The default implementation is a no-op.

Parameters

componentDefinition:BeanComponentDefinition: the BeanComponentDefinition that is to be processed

registerBeanDefinition back to summary

registerBeanDefinition	back to summary
protected void registerBeanDefinition(BeanDefinitionHolder definition, BeanDefinitionRegistry registry) Register the supplied `bean` with the supplied `registry`. Subclasses can override this method to control whether the supplied `bean` is actually even registered, or to register even more beans. The default implementation registers the supplied `bean` with the supplied `registry` only if the `isNested` parameter is `false`, because one typically does not want inner beans to be registered as top level beans. Parameters definition:BeanDefinitionHolder the bean definition to be registered registry:BeanDefinitionRegistry the registry that the bean is to be registered with See Also `BeanDefinitionReaderUtils#registerBeanDefinition(BeanDefinitionHolder, BeanDefinitionRegistry)`

protected void registerBeanDefinition(BeanDefinitionHolder definition, BeanDefinitionRegistry registry)

Subclasses can override this method to control whether the supplied bean is actually even registered, or to register even more beans.

The default implementation registers the supplied bean with the supplied registry only if the isNested parameter is false, because one typically does not want inner beans to be registered as top level beans.

Parameters

definition:BeanDefinitionHolder: the bean definition to be registered
registry:BeanDefinitionRegistry: the registry that the bean is to be registered with

resolveId back to summary

resolveId	back to summary
protected String resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext) throws BeanDefinitionStoreException Resolve the ID for the supplied `BeanDefinition`. When using `generation`, a name is generated automatically. Otherwise, the ID is extracted from the "id" attribute, potentially with a `fallback` to a generated id. Parameters element:Element the element that the bean definition has been built from definition:AbstractBeanDefinition the bean definition to be registered parserContext:ParserContext the object encapsulating the current state of the parsing process; provides access to a `org.springframework.beans.factory.support.BeanDefinitionRegistry` Returns:String the resolved id Exceptions BeanDefinitionStoreException: if no unique name could be generated for the given bean definition

protected String resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext) throws BeanDefinitionStoreException

Resolve the ID for the supplied BeanDefinition.

When using generation, a name is generated automatically. Otherwise, the ID is extracted from the "id" attribute, potentially with a fallback to a generated id.

Parameters

element:Element: the element that the bean definition has been built from
definition:AbstractBeanDefinition: the bean definition to be registered
parserContext:ParserContext: the object encapsulating the current state of the parsing process; provides access to a org.springframework.beans.factory.support.BeanDefinitionRegistry

Returns:String

the resolved id

Exceptions

BeanDefinitionStoreException:: if no unique name could be generated for the given bean definition

shouldFireEvents back to summary

shouldFireEvents	back to summary
protected boolean shouldFireEvents() Determine whether this parser is supposed to fire a `org.springframework.beans.factory.parsing.BeanComponentDefinition` event after parsing the bean definition. This implementation returns `true` by default; that is, an event will be fired when a bean definition has been completely parsed. Override this to return `false` in order to suppress the event. Returns:boolean `true` in order to fire a component registration event after parsing the bean definition; `false` to suppress the event See Also `postProcessComponentDefinition`, `org.springframework.beans.factory.parsing.ReaderContext#fireComponentRegistered`

protected boolean shouldFireEvents()

Determine whether this parser is supposed to fire a org.springframework.beans.factory.parsing.BeanComponentDefinition event after parsing the bean definition.

This implementation returns true by default; that is, an event will be fired when a bean definition has been completely parsed. Override this to return false in order to suppress the event.

Returns:boolean: true in order to fire a component registration event after parsing the bean definition; false to suppress the event
See Also: postProcessComponentDefinition, org.springframework.beans.factory.parsing.ReaderContext#fireComponentRegistered

shouldGenerateId back to summary

shouldGenerateId	back to summary
protected boolean shouldGenerateId() Should an ID be generated instead of read from the passed in `Element`? Disabled by default; subclasses can override this to enable ID generation. Note that this flag is about always generating an ID; the parser won't even check for an "id" attribute in this case. Returns:boolean whether the parser should always generate an id

protected boolean shouldGenerateId()

Should an ID be generated instead of read from the passed in Element?

Disabled by default; subclasses can override this to enable ID generation. Note that this flag is about always generating an ID; the parser won't even check for an "id" attribute in this case.

Returns:boolean: whether the parser should always generate an id

shouldGenerateIdAsFallback back to summary

shouldGenerateIdAsFallback	back to summary
protected boolean shouldGenerateIdAsFallback() Should an ID be generated instead if the passed in `Element` does not specify an "id" attribute explicitly? Disabled by default; subclasses can override this to enable ID generation as fallback: The parser will first check for an "id" attribute in this case, only falling back to a generated ID if no value was specified. Returns:boolean whether the parser should generate an id if no id was specified

protected boolean shouldGenerateIdAsFallback()

Should an ID be generated instead if the passed in Element does not specify an "id" attribute explicitly?

Disabled by default; subclasses can override this to enable ID generation as fallback: The parser will first check for an "id" attribute in this case, only falling back to a generated ID if no value was specified.

Returns:boolean: whether the parser should generate an id if no id was specified

shouldParseNameAsAliases back to summary

shouldParseNameAsAliases	back to summary
protected boolean shouldParseNameAsAliases() Determine whether the element's "name" attribute should get parsed as bean definition aliases, i.e. alternative bean definition names. The default implementation returns `true`. Returns:boolean whether the parser should evaluate the "name" attribute as aliases Since 4.1.5

protected boolean shouldParseNameAsAliases()

Determine whether the element's "name" attribute should get parsed as bean definition aliases, i.e. alternative bean definition names.

The default implementation returns true.

Returns:boolean: whether the parser should evaluate the "name" attribute as aliases
Since: 4.1.5

public abstract Class AbstractBeanDefinitionParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail