Top Description Inners Fields Constructors Methods
org.springframework.beans.factory.xml

public Class UtilNamespaceHandler

extends NamespaceHandlerSupport
Class Inheritance
Imports
java.util.List, .Map, .Properties, .Set, org.w3c.dom.Element, org.springframework.beans.factory.config.FieldRetrievingFactoryBean, .ListFactoryBean, .MapFactoryBean, .PropertiesFactoryBean, .PropertyPathFactoryBean, .SetFactoryBean, org.springframework.beans.factory.support.AbstractBeanDefinition, .BeanDefinitionBuilder, org.springframework.util.StringUtils
NamespaceHandler for the util namespace.
Authors
Rob Harrop, Juergen Hoeller
Since
2.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
UtilNamespaceHandler.ConstantBeanDefinitionParser

private static class
UtilNamespaceHandler.ListBeanDefinitionParser

private static class
UtilNamespaceHandler.MapBeanDefinitionParser

private static class
UtilNamespaceHandler.PropertiesBeanDefinitionParser

private static class
UtilNamespaceHandler.PropertyPathBeanDefinitionParser

private static class
UtilNamespaceHandler.SetBeanDefinitionParser

Field Summary

Modifier and TypeField and Description
private static final String
SCOPE_ATTRIBUTE

Constructor Summary

AccessConstructor and Description
public
UtilNamespaceHandler()

Method Summary

Modifier and TypeMethod and Description
public void
init()

Implements org.springframework.beans.factory.xml.NamespaceHandler.init.

Invoked by the DefaultBeanDefinitionDocumentReader after construction but before any custom elements are parsed.
Inherited from org.springframework.beans.factory.xml.NamespaceHandlerSupport:
decorateparseregisterBeanDefinitionDecoratorregisterBeanDefinitionDecoratorForAttributeregisterBeanDefinitionParser

Field Detail

SCOPE_ATTRIBUTEback to summary
private static final String SCOPE_ATTRIBUTE

Constructor Detail

UtilNamespaceHandlerback to summary
public UtilNamespaceHandler()

Method Detail

initback to summary
public void init()

Implements org.springframework.beans.factory.xml.NamespaceHandler.init.

Doc from org.springframework.beans.factory.xml.NamespaceHandler.init.

Invoked by the DefaultBeanDefinitionDocumentReader after construction but before any custom elements are parsed.

Annotations
@Override
org.springframework.beans.factory.xml back to summary

private Class UtilNamespaceHandler.ConstantBeanDefinitionParser

extends AbstractSimpleBeanDefinitionParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
ConstantBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
protected Class<?>
getBeanClass(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.
protected String
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)

Overrides org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.resolveId.

Resolve the ID for the supplied BeanDefinition.
Inherited from org.springframework.beans.factory.xml.AbstractSimpleBeanDefinitionParser:
doParseextractPropertyNameisEligibleAttributeisEligibleAttributepostProcess

Constructor Detail

ConstantBeanDefinitionParserback to summary
private ConstantBeanDefinitionParser()

Method Detail

getBeanClassback to summary
protected Class<?> getBeanClass(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.

Note that, for application classes, it is generally preferable to override getBeanClassName instead, in order to avoid a direct dependence on the bean implementation class. The BeanDefinitionParser and its NamespaceHandler can be used within an IDE plugin then, even if the application classes are not available on the plugin's classpath.

Parameters
element:Element

the Element that is being parsed

Returns:Class<?>

the Class of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override
resolveIdback to summary
protected String resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext)

Overrides org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.resolveId.

Doc from org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.resolveId.

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

Annotations
@Override
org.springframework.beans.factory.xml back to summary

private Class UtilNamespaceHandler.ListBeanDefinitionParser

extends AbstractSingleBeanDefinitionParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
ListBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
protected void
doParse(Element
the XML element being parsed
element, ParserContext
the object encapsulating the current state of the parsing process
parserContext, BeanDefinitionBuilder
used to define the BeanDefinition
builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.
protected Class<?>
getBeanClass(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.
Inherited from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser:
doParsegetBeanClassNamegetParentNameparseInternal

Constructor Detail

ListBeanDefinitionParserback to summary
private ListBeanDefinitionParser()

Method Detail

doParseback to summary
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

The default implementation delegates to the doParse version without ParserContext argument.

Parameters
element:Element

the XML element being parsed

parserContext:ParserContext

the object encapsulating the current state of the parsing process

builder:BeanDefinitionBuilder

used to define the BeanDefinition

Annotations
@Override
getBeanClassback to summary
protected Class<?> getBeanClass(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.

Note that, for application classes, it is generally preferable to override getBeanClassName instead, in order to avoid a direct dependence on the bean implementation class. The BeanDefinitionParser and its NamespaceHandler can be used within an IDE plugin then, even if the application classes are not available on the plugin's classpath.

Parameters
element:Element

the Element that is being parsed

Returns:Class<?>

the Class of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override
org.springframework.beans.factory.xml back to summary

private Class UtilNamespaceHandler.MapBeanDefinitionParser

extends AbstractSingleBeanDefinitionParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
MapBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
protected void
doParse(Element
the XML element being parsed
element, ParserContext
the object encapsulating the current state of the parsing process
parserContext, BeanDefinitionBuilder
used to define the BeanDefinition
builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.
protected Class<?>
getBeanClass(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.
Inherited from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser:
doParsegetBeanClassNamegetParentNameparseInternal

Constructor Detail

MapBeanDefinitionParserback to summary
private MapBeanDefinitionParser()

Method Detail

doParseback to summary
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

The default implementation delegates to the doParse version without ParserContext argument.

Parameters
element:Element

the XML element being parsed

parserContext:ParserContext

the object encapsulating the current state of the parsing process

builder:BeanDefinitionBuilder

used to define the BeanDefinition

Annotations
@Override
getBeanClassback to summary
protected Class<?> getBeanClass(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.

Note that, for application classes, it is generally preferable to override getBeanClassName instead, in order to avoid a direct dependence on the bean implementation class. The BeanDefinitionParser and its NamespaceHandler can be used within an IDE plugin then, even if the application classes are not available on the plugin's classpath.

Parameters
element:Element

the Element that is being parsed

Returns:Class<?>

the Class of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override
org.springframework.beans.factory.xml back to summary

private Class UtilNamespaceHandler.PropertiesBeanDefinitionParser

extends AbstractSingleBeanDefinitionParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
PropertiesBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
protected void
doParse(Element
the XML element being parsed
element, ParserContext
the object encapsulating the current state of the parsing process
parserContext, BeanDefinitionBuilder
used to define the BeanDefinition
builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.
protected Class<?>
getBeanClass(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.
Inherited from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser:
doParsegetBeanClassNamegetParentNameparseInternal

Constructor Detail

PropertiesBeanDefinitionParserback to summary
private PropertiesBeanDefinitionParser()

Method Detail

doParseback to summary
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

The default implementation delegates to the doParse version without ParserContext argument.

Parameters
element:Element

the XML element being parsed

parserContext:ParserContext

the object encapsulating the current state of the parsing process

builder:BeanDefinitionBuilder

used to define the BeanDefinition

Annotations
@Override
getBeanClassback to summary
protected Class<?> getBeanClass(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.

Note that, for application classes, it is generally preferable to override getBeanClassName instead, in order to avoid a direct dependence on the bean implementation class. The BeanDefinitionParser and its NamespaceHandler can be used within an IDE plugin then, even if the application classes are not available on the plugin's classpath.

Parameters
element:Element

the Element that is being parsed

Returns:Class<?>

the Class of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override
org.springframework.beans.factory.xml back to summary

private Class UtilNamespaceHandler.PropertyPathBeanDefinitionParser

extends AbstractSingleBeanDefinitionParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
PropertyPathBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
protected void
doParse(Element
the XML element being parsed
element, ParserContext
the object encapsulating the current state of the parsing process
parserContext, BeanDefinitionBuilder
used to define the BeanDefinition
builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.
protected Class<?>
getBeanClass(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.
protected String
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)

Overrides org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.resolveId.

Resolve the ID for the supplied BeanDefinition.
Inherited from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser:
doParsegetBeanClassNamegetParentNameparseInternal

Constructor Detail

PropertyPathBeanDefinitionParserback to summary
private PropertyPathBeanDefinitionParser()

Method Detail

doParseback to summary
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

The default implementation delegates to the doParse version without ParserContext argument.

Parameters
element:Element

the XML element being parsed

parserContext:ParserContext

the object encapsulating the current state of the parsing process

builder:BeanDefinitionBuilder

used to define the BeanDefinition

Annotations
@Override
getBeanClassback to summary
protected Class<?> getBeanClass(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.

Note that, for application classes, it is generally preferable to override getBeanClassName instead, in order to avoid a direct dependence on the bean implementation class. The BeanDefinitionParser and its NamespaceHandler can be used within an IDE plugin then, even if the application classes are not available on the plugin's classpath.

Parameters
element:Element

the Element that is being parsed

Returns:Class<?>

the Class of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override
resolveIdback to summary
protected String resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext)

Overrides org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.resolveId.

Doc from org.springframework.beans.factory.xml.AbstractBeanDefinitionParser.resolveId.

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

Annotations
@Override
org.springframework.beans.factory.xml back to summary

private Class UtilNamespaceHandler.SetBeanDefinitionParser

extends AbstractSingleBeanDefinitionParser
Class Inheritance

Constructor Summary

AccessConstructor and Description
private
SetBeanDefinitionParser()

Method Summary

Modifier and TypeMethod and Description
protected void
doParse(Element
the XML element being parsed
element, ParserContext
the object encapsulating the current state of the parsing process
parserContext, BeanDefinitionBuilder
used to define the BeanDefinition
builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.
protected Class<?>
getBeanClass(Element
the Element that is being parsed
element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.
Inherited from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser:
doParsegetBeanClassNamegetParentNameparseInternal

Constructor Detail

SetBeanDefinitionParserback to summary
private SetBeanDefinitionParser()

Method Detail

doParseback to summary
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.doParse.

Parse the supplied Element and populate the supplied BeanDefinitionBuilder as required.

The default implementation delegates to the doParse version without ParserContext argument.

Parameters
element:Element

the XML element being parsed

parserContext:ParserContext

the object encapsulating the current state of the parsing process

builder:BeanDefinitionBuilder

used to define the BeanDefinition

Annotations
@Override
getBeanClassback to summary
protected Class<?> getBeanClass(Element element)

Overrides org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Doc from org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser.getBeanClass.

Determine the bean class corresponding to the supplied Element.

Note that, for application classes, it is generally preferable to override getBeanClassName instead, in order to avoid a direct dependence on the bean implementation class. The BeanDefinitionParser and its NamespaceHandler can be used within an IDE plugin then, even if the application classes are not available on the plugin's classpath.

Parameters
element:Element

the Element that is being parsed

Returns:Class<?>

the Class of the bean that is being defined via parsing the supplied Element, or null if none

Annotations
@Override