org.springframework.context.annotation

Class ConfigurationClassParser

java.lang.Object

org.springframework.context.annotation.ConfigurationClassParser

class ConfigurationClassParser
extends java.lang.Object

Parses a Configuration class definition, populating a collection of ConfigurationClass objects (parsing a single Configuration class may result in any number of ConfigurationClass objects because one Configuration class may import another using the Import annotation).

This class helps separate the concern of parsing the structure of a Configuration class from the concern of registering BeanDefinition objects based on the content of that model (with the exception of @ComponentScan annotations which need to be registered immediately).

This ASM-based implementation avoids reflection and eager class loading in order to interoperate effectively with lazy class loading in a Spring ApplicationContext.

Since:

3.0

Author:

Chris Beams, Juergen Hoeller, Phillip Webb, Sam Brannen

See Also:

ConfigurationClassBeanDefinitionReader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ConfigurationClassParser.CircularImportProblem Problem registered upon detection of a circular Import.
private static class	ConfigurationClassParser.DeferredImportSelectorHolder
private static class	ConfigurationClassParser.ImportStack
private class	ConfigurationClassParser.SourceClass Simple wrapper that allows annotated source classes to be dealt with in a uniform manner, regardless of how they are loaded.

Field Summary

Fields

Modifier and Type	Field and Description
private ComponentScanAnnotationParser	componentScanParser
private ConditionEvaluator	conditionEvaluator
private java.util.Map<ConfigurationClass,ConfigurationClass>	configurationClasses
private static java.util.Comparator<ConfigurationClassParser.DeferredImportSelectorHolder>	DEFERRED_IMPORT_COMPARATOR
private java.util.List<ConfigurationClassParser.DeferredImportSelectorHolder>	deferredImportSelectors
private Environment	environment
private ConfigurationClassParser.ImportStack	importStack
private java.util.Map<java.lang.String,ConfigurationClass>	knownSuperclasses
private Log	logger
private MetadataReaderFactory	metadataReaderFactory
private ProblemReporter	problemReporter
private java.util.List<java.lang.String>	propertySourceNames
private BeanDefinitionRegistry	registry
private ResourceLoader	resourceLoader

Constructor Summary

Constructors

Constructor and Description
ConfigurationClassParser(MetadataReaderFactory metadataReaderFactory, ProblemReporter problemReporter, Environment environment, ResourceLoader resourceLoader, BeanNameGenerator componentScanBeanNameGenerator, BeanDefinitionRegistry registry) Create a new ConfigurationClassParser instance that will be used to populate the set of configuration classes.

Method Summary

Modifier and Type	Method and Description
private void	addPropertySource(ResourcePropertySource propertySource)
ConfigurationClassParser.SourceClass	asSourceClass(java.lang.Class<?> classType) Factory method to obtain a ConfigurationClassParser.SourceClass from a Class.
ConfigurationClassParser.SourceClass	asSourceClass(ConfigurationClass configurationClass) Factory method to obtain a ConfigurationClassParser.SourceClass from a ConfigurationClass.
ConfigurationClassParser.SourceClass	asSourceClass(java.lang.String className) Factory method to obtain a ConfigurationClassParser.SourceClass from a class name.
java.util.Collection<ConfigurationClassParser.SourceClass>	asSourceClasses(java.lang.String[] classNames) Factory method to obtain ConfigurationClassParser.SourceClasss from class names.
private void	collectImports(ConfigurationClassParser.SourceClass sourceClass, java.util.Set<ConfigurationClassParser.SourceClass> imports, java.util.Set<ConfigurationClassParser.SourceClass> visited) Recursively collect all declared @Import values.
protected ConfigurationClassParser.SourceClass	doProcessConfigurationClass(ConfigurationClass configClass, ConfigurationClassParser.SourceClass sourceClass) Apply processing and build a complete ConfigurationClass by reading the annotations, members and methods from the source class.
java.util.Set<ConfigurationClass>	getConfigurationClasses()
(package private) ImportRegistry	getImportRegistry()
private java.util.Set<ConfigurationClassParser.SourceClass>	getImports(ConfigurationClassParser.SourceClass sourceClass) Returns @Import class, considering all meta-annotations.
private void	invokeAwareMethods(java.lang.Object importStrategyBean) Invoke ResourceLoaderAware, BeanClassLoaderAware and BeanFactoryAware contracts if implemented by the given bean.
protected void	parse(AnnotationMetadata metadata, java.lang.String beanName)
protected void	parse(java.lang.Class<?> clazz, java.lang.String beanName)
void	parse(java.util.Set<BeanDefinitionHolder> configCandidates)
protected void	parse(java.lang.String className, java.lang.String beanName)
protected void	processConfigurationClass(ConfigurationClass configClass)
private void	processDeferredImportSelectors()
private void	processImports(ConfigurationClass configClass, ConfigurationClassParser.SourceClass currentSourceClass, java.util.Collection<ConfigurationClassParser.SourceClass> importCandidates, boolean checkForCircularImports)
private void	processMemberClasses(ConfigurationClass configClass, ConfigurationClassParser.SourceClass sourceClass) Register member (nested) classes that happen to be configuration classes themselves.
private void	processPropertySource(AnnotationAttributes propertySource) Process the given @PropertySource annotation metadata.
void	validate() Validate each ConfigurationClass object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFERRED_IMPORT_COMPARATOR

private static final java.util.Comparator<ConfigurationClassParser.DeferredImportSelectorHolder> DEFERRED_IMPORT_COMPARATOR

logger

private final Log logger

metadataReaderFactory

private final MetadataReaderFactory metadataReaderFactory

problemReporter

private final ProblemReporter problemReporter

environment

private final Environment environment

resourceLoader

private final ResourceLoader resourceLoader

registry

private final BeanDefinitionRegistry registry

componentScanParser

private final ComponentScanAnnotationParser componentScanParser

conditionEvaluator

private final ConditionEvaluator conditionEvaluator

configurationClasses

private final java.util.Map<ConfigurationClass,ConfigurationClass> configurationClasses

knownSuperclasses

private final java.util.Map<java.lang.String,ConfigurationClass> knownSuperclasses

propertySourceNames

private final java.util.List<java.lang.String> propertySourceNames

importStack

private final ConfigurationClassParser.ImportStack importStack

deferredImportSelectors

private java.util.List<ConfigurationClassParser.DeferredImportSelectorHolder> deferredImportSelectors

Constructor Detail

ConfigurationClassParser

public ConfigurationClassParser(MetadataReaderFactory metadataReaderFactory,
                                ProblemReporter problemReporter,
                                Environment environment,
                                ResourceLoader resourceLoader,
                                BeanNameGenerator componentScanBeanNameGenerator,
                                BeanDefinitionRegistry registry)

Create a new ConfigurationClassParser instance that will be used to populate the set of configuration classes.

Method Detail

parse

public void parse(java.util.Set<BeanDefinitionHolder> configCandidates)

parse

protected final void parse(java.lang.String className,
                           java.lang.String beanName)
                    throws java.io.IOException

Throws:

java.io.IOException

parse

protected final void parse(java.lang.Class<?> clazz,
                           java.lang.String beanName)
                    throws java.io.IOException

Throws:

java.io.IOException

parse

protected final void parse(AnnotationMetadata metadata,
                           java.lang.String beanName)
                    throws java.io.IOException

Throws:

java.io.IOException

processConfigurationClass

protected void processConfigurationClass(ConfigurationClass configClass)
                                  throws java.io.IOException

Throws:

java.io.IOException

doProcessConfigurationClass

protected final ConfigurationClassParser.SourceClass doProcessConfigurationClass(ConfigurationClass configClass,
                                                                                 ConfigurationClassParser.SourceClass sourceClass)
                                                                          throws java.io.IOException

Apply processing and build a complete ConfigurationClass by reading the annotations, members and methods from the source class. This method can be called multiple times as relevant sources are discovered.

Parameters:

configClass - the configuration class being build

sourceClass - a source class

Returns:

the superclass, or null if none found or previously processed

Throws:

java.io.IOException

processMemberClasses

private void processMemberClasses(ConfigurationClass configClass,
                                  ConfigurationClassParser.SourceClass sourceClass)
                           throws java.io.IOException

Register member (nested) classes that happen to be configuration classes themselves.

Parameters:

sourceClass - the source class to process

Throws:

java.io.IOException - if there is any problem reading metadata from a member class

processPropertySource

private void processPropertySource(AnnotationAttributes propertySource)
                            throws java.io.IOException

Process the given @PropertySource annotation metadata.

Parameters:

propertySource - metadata for the @PropertySource annotation found

Throws:

java.io.IOException - if loading a property source failed

addPropertySource

private void addPropertySource(ResourcePropertySource propertySource)

getImports

private java.util.Set<ConfigurationClassParser.SourceClass> getImports(ConfigurationClassParser.SourceClass sourceClass)
                                                                throws java.io.IOException

Returns @Import class, considering all meta-annotations.

Throws:

java.io.IOException

collectImports

private void collectImports(ConfigurationClassParser.SourceClass sourceClass,
                            java.util.Set<ConfigurationClassParser.SourceClass> imports,
                            java.util.Set<ConfigurationClassParser.SourceClass> visited)
                     throws java.io.IOException

Recursively collect all declared @Import values. Unlike most meta-annotations it is valid to have several @Imports declared with different values; the usual process of returning values from the first meta-annotation on a class is not sufficient.

For example, it is common for a @Configuration class to declare direct @Imports in addition to meta-imports originating from an @Enable annotation.

Parameters:

sourceClass - the class to search

imports - the imports collected so far

visited - used to track visited classes to prevent infinite recursion

Throws:

java.io.IOException - if there is any problem reading metadata from the named class

processDeferredImportSelectors

private void processDeferredImportSelectors()

processImports

private void processImports(ConfigurationClass configClass,
                            ConfigurationClassParser.SourceClass currentSourceClass,
                            java.util.Collection<ConfigurationClassParser.SourceClass> importCandidates,
                            boolean checkForCircularImports)
                     throws java.io.IOException

Throws:

java.io.IOException

invokeAwareMethods

private void invokeAwareMethods(java.lang.Object importStrategyBean)

Invoke ResourceLoaderAware, BeanClassLoaderAware and BeanFactoryAware contracts if implemented by the given bean.

validate

public void validate()

Validate each ConfigurationClass object.

See Also:

ConfigurationClass.validate(org.springframework.beans.factory.parsing.ProblemReporter)

getConfigurationClasses

public java.util.Set<ConfigurationClass> getConfigurationClasses()

getImportRegistry

ImportRegistry getImportRegistry()

asSourceClass

public ConfigurationClassParser.SourceClass asSourceClass(ConfigurationClass configurationClass)
                                                   throws java.io.IOException

Factory method to obtain a ConfigurationClassParser.SourceClass from a ConfigurationClass.

Throws:

java.io.IOException

asSourceClass

public ConfigurationClassParser.SourceClass asSourceClass(java.lang.Class<?> classType)
                                                   throws java.io.IOException

Factory method to obtain a ConfigurationClassParser.SourceClass from a Class.

Throws:

java.io.IOException

asSourceClasses

public java.util.Collection<ConfigurationClassParser.SourceClass> asSourceClasses(java.lang.String[] classNames)
                                                                           throws java.io.IOException

Factory method to obtain ConfigurationClassParser.SourceClasss from class names.

Throws:

java.io.IOException

asSourceClass

public ConfigurationClassParser.SourceClass asSourceClass(java.lang.String className)
                                                   throws java.io.IOException

Factory method to obtain a ConfigurationClassParser.SourceClass from a class name.

Throws:

java.io.IOException