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

public Class XmlReaderContext

extends ReaderContext
Class Inheritance
Imports
java.io.StringReader, org.w3c.dom.Document, org.xml.sax.InputSource, org.springframework.beans.factory.BeanDefinitionStoreException, org.springframework.beans.factory.config.BeanDefinition, org.springframework.beans.factory.parsing.ProblemReporter, .ReaderContext, .ReaderEventListener, .SourceExtractor, org.springframework.beans.factory.support.BeanDefinitionRegistry, org.springframework.core.env.Environment, org.springframework.core.io.Resource, .ResourceLoader, org.springframework.lang.Nullable

Extension of org.springframework.beans.factory.parsing.ReaderContext, specific to use with an XmlBeanDefinitionReader. Provides access to the NamespaceHandlerResolver configured in the XmlBeanDefinitionReader.
Authors
Rob Harrop, Juergen Hoeller
Since
2.0

Field Summary

Modifier and TypeField and Description
private final NamespaceHandlerResolver
private final XmlBeanDefinitionReader

Constructor Summary

AccessConstructor and Description
public
XmlReaderContext(Resource
the XML bean definition resource
resource
,
ProblemReporter
the problem reporter in use
problemReporter
,
ReaderEventListener
the event listener in use
eventListener
,
SourceExtractor
the source extractor in use
sourceExtractor
,
XmlBeanDefinitionReader
the XML bean definition reader in use
reader
,
NamespaceHandlerResolver
the XML namespace resolver
namespaceHandlerResolver
)

Construct a new XmlReaderContext.

Method Summary

Modifier and TypeMethod and Description
public String
generateBeanName(BeanDefinition beanDefinition)

Call the bean name generator for the given bean definition.

public final ClassLoader
getBeanClassLoader()

Return the bean class loader to use, if any.

public final Environment
getEnvironment()

Return the environment to use.

public final NamespaceHandlerResolver
getNamespaceHandlerResolver()

Return the namespace resolver.

public final XmlBeanDefinitionReader
getReader()

Return the XML bean definition reader in use.

public final BeanDefinitionRegistry
getRegistry()

Return the bean definition registry to use.

public final ResourceLoader
getResourceLoader()

Return the resource loader to use, if any.

public Document
readDocumentFromString(String documentContent)

Read an XML document from the given String.

public String
registerWithGeneratedName(BeanDefinition beanDefinition)

Call the bean name generator for the given bean definition and register the bean definition under the generated name.

Inherited from org.springframework.beans.factory.parsing.ReaderContext:
errorerrorerrorerrorextractSourcefatalfatalfatalfatalfireAliasRegisteredfireComponentRegisteredfireDefaultsRegisteredfireImportProcessedfireImportProcessedgetResourcegetSourceExtractorwarningwarningwarningwarning

Field Detail

namespaceHandlerResolverback to summary
private final NamespaceHandlerResolver namespaceHandlerResolver
readerback to summary
private final XmlBeanDefinitionReader reader

Constructor Detail

XmlReaderContextback to summary
public XmlReaderContext(Resource resource, ProblemReporter problemReporter, ReaderEventListener eventListener, SourceExtractor sourceExtractor, XmlBeanDefinitionReader reader, NamespaceHandlerResolver namespaceHandlerResolver)

Construct a new XmlReaderContext.

Parameters
resource:Resource

the XML bean definition resource

problemReporter:ProblemReporter

the problem reporter in use

eventListener:ReaderEventListener

the event listener in use

sourceExtractor:SourceExtractor

the source extractor in use

reader:XmlBeanDefinitionReader

the XML bean definition reader in use

namespaceHandlerResolver:NamespaceHandlerResolver

the XML namespace resolver

Method Detail

generateBeanNameback to summary
public String generateBeanName(BeanDefinition beanDefinition)

Call the bean name generator for the given bean definition.

See Also
XmlBeanDefinitionReader#getBeanNameGenerator(), org.springframework.beans.factory.support.BeanNameGenerator#generateBeanName
getBeanClassLoaderback to summary
public final ClassLoader getBeanClassLoader()

Return the bean class loader to use, if any.

Note that this will be null in regular scenarios, as an indication to lazily resolve bean classes.

Annotations
@Nullable
See Also
XmlBeanDefinitionReader#setBeanClassLoader
getEnvironmentback to summary
public final Environment getEnvironment()

Return the environment to use.

See Also
XmlBeanDefinitionReader#setEnvironment
getNamespaceHandlerResolverback to summary
public final NamespaceHandlerResolver getNamespaceHandlerResolver()

Return the namespace resolver.

See Also
XmlBeanDefinitionReader#setNamespaceHandlerResolver
getReaderback to summary
public final XmlBeanDefinitionReader getReader()

Return the XML bean definition reader in use.

getRegistryback to summary
public final BeanDefinitionRegistry getRegistry()

Return the bean definition registry to use.

See Also
XmlBeanDefinitionReader#XmlBeanDefinitionReader(BeanDefinitionRegistry)
getResourceLoaderback to summary
public final ResourceLoader getResourceLoader()

Return the resource loader to use, if any.

This will be non-null in regular scenarios, also allowing access to the resource class loader.

Annotations
@Nullable
See Also
XmlBeanDefinitionReader#setResourceLoader, ResourceLoader#getClassLoader()
readDocumentFromStringback to summary
public Document readDocumentFromString(String documentContent)

Read an XML document from the given String.

See Also
getReader()
registerWithGeneratedNameback to summary
public String registerWithGeneratedName(BeanDefinition beanDefinition)

Call the bean name generator for the given bean definition and register the bean definition under the generated name.

See Also
XmlBeanDefinitionReader#getBeanNameGenerator(), org.springframework.beans.factory.support.BeanNameGenerator#generateBeanName, BeanDefinitionRegistry#registerBeanDefinition