Spring Context 6.1.4 · org.springframework.context.annotation.ConfigurationClassParser

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.

Modifier and Type	Class and Description
private static class	ConfigurationClassParser.CircularImportProblem `Problem` registered upon detection of a circular `Import`.
private static class	ConfigurationClassParser.DefaultDeferredImportSelectorGroup
private static class	ConfigurationClassParser.DeferredImportSelectorGrouping
private class	ConfigurationClassParser.DeferredImportSelectorGroupingHandler
private class	ConfigurationClassParser.DeferredImportSelectorHandler
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.

Modifier and Type

Class and Description

private static class

ConfigurationClassParser.CircularImportProblem

Problem registered upon detection of a circular Import.

private static class

ConfigurationClassParser.DefaultDeferredImportSelectorGroup

private static class

ConfigurationClassParser.DeferredImportSelectorGrouping

private class

ConfigurationClassParser.DeferredImportSelectorGroupingHandler

private class

ConfigurationClassParser.DeferredImportSelectorHandler

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.

Modifier and Type	Field and Description
private final ComponentScanAnnotationParser	componentScanParser
private final ConditionEvaluator	conditionEvaluator
private final Map<ConfigurationClass, ConfigurationClass>	configurationClasses
private static final Predicate<String>	DEFAULT_EXCLUSION_FILTER
private static final Comparator<ConfigurationClassParser.DeferredImportSelectorHolder>	DEFERRED_IMPORT_COMPARATOR
private final ConfigurationClassParser.DeferredImportSelectorHandler	deferredImportSelectorHandler
private final Environment	environment
private final ConfigurationClassParser.ImportStack	importStack
private final Map<String, ConfigurationClass>	knownSuperclasses
private final Log	logger
private final MetadataReaderFactory	metadataReaderFactory
private final ConfigurationClassParser.SourceClass	objectSourceClass
private final ProblemReporter	problemReporter
private final PropertySourceRegistry	propertySourceRegistry
private final BeanDefinitionRegistry	registry
private final ResourceLoader	resourceLoader

Modifier and Type

Field and Description

private final ComponentScanAnnotationParser

componentScanParser

private final ConditionEvaluator

conditionEvaluator

private final Map<ConfigurationClass, ConfigurationClass>

configurationClasses

private static final Predicate<String>

DEFAULT_EXCLUSION_FILTER

private static final Comparator<ConfigurationClassParser.DeferredImportSelectorHolder>

DEFERRED_IMPORT_COMPARATOR

private final ConfigurationClassParser.DeferredImportSelectorHandler

deferredImportSelectorHandler

private final Environment

environment

private final ConfigurationClassParser.ImportStack

importStack

private final Map<String, ConfigurationClass>

knownSuperclasses

private final Log

logger

private final MetadataReaderFactory

metadataReaderFactory

private final ConfigurationClassParser.SourceClass

objectSourceClass

private final ProblemReporter

problemReporter

private final PropertySourceRegistry

propertySourceRegistry

private final BeanDefinitionRegistry

registry

private final ResourceLoader

resourceLoader

Constructor Summary

Access	Constructor and Description
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.

Access

Constructor and Description

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 Summary

Modifier and Type	Method and Description
private ConfigurationClassParser.SourceClass	asSourceClass(ConfigurationClass configurationClass, Predicate<String> filter) Factory method to obtain a `SourceClass` from a `ConfigurationClass`.
pack-priv ConfigurationClassParser.SourceClass	asSourceClass(Class<?> classType, Predicate<String> filter) Factory method to obtain a `SourceClass` from a `Class`.
pack-priv ConfigurationClassParser.SourceClass	asSourceClass(String className, Predicate<String> filter) Factory method to obtain a `SourceClass` from a class name.
private Collection<ConfigurationClassParser.SourceClass>	asSourceClasses(String[] classNames, Predicate<String> filter) Factory method to obtain a `SourceClass` collection from class names.
private void	collectImports(ConfigurationClassParser.SourceClass the class to search sourceClass, Set<ConfigurationClassParser.SourceClass> the imports collected so far imports, Set<ConfigurationClassParser.SourceClass> used to track visited classes to prevent infinite recursion visited) Recursively collect all declared `@Import` values.
protected final ConfigurationClassParser.SourceClass	Returns: the superclass, or `null` if none found or previously processed doProcessConfigurationClass(ConfigurationClass the configuration class being build configClass, ConfigurationClassParser.SourceClass a source class sourceClass, Predicate<String> filter) Apply processing and build a complete `ConfigurationClass` by reading the annotations, members and methods from the source class.
public Set<ConfigurationClass>	getConfigurationClasses()
pack-priv ImportRegistry	getImportRegistry()
private Set<ConfigurationClassParser.SourceClass>	getImports(ConfigurationClassParser.SourceClass sourceClass) Returns `@Import` class, considering all meta-annotations.
pack-priv List<PropertySourceDescriptor>	getPropertySourceDescriptors()
private boolean	isChainedImportOnStack(ConfigurationClass configClass)
public void	parse(Set<BeanDefinitionHolder> configCandidates)
protected final void	parse(String className, String beanName)
protected final void	parse(Class<?> clazz, String beanName)
protected final void	parse(AnnotationMetadata metadata, String beanName)
protected void	processConfigurationClass(ConfigurationClass configClass, Predicate<String> filter)
private void	processImports(ConfigurationClass configClass, ConfigurationClassParser.SourceClass currentSourceClass, Collection<ConfigurationClassParser.SourceClass> importCandidates, Predicate<String> exclusionFilter, boolean checkForCircularImports)
private void	processInterfaces(ConfigurationClass configClass, ConfigurationClassParser.SourceClass sourceClass) Register default methods on interfaces implemented by the configuration class.
private void	processMemberClasses(ConfigurationClass configClass, ConfigurationClassParser.SourceClass sourceClass, Predicate<String> filter) Register member (nested) classes that happen to be configuration classes themselves.
private Set<MethodMetadata>	retrieveBeanMethodMetadata(ConfigurationClassParser.SourceClass sourceClass) Retrieve the metadata for all `@Bean` methods.
public void	validate() Validate each `ConfigurationClass` object.

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

pack-priv Class ConfigurationClassParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary