org.springframework.context.annotation

Class ConfigurationClass

java.lang.Object

org.springframework.context.annotation.ConfigurationClass

final class ConfigurationClass
extends java.lang.Object

Represents a user-defined @Configuration class. Includes a set of Bean methods, including all such methods defined in the ancestry of the class, in a 'flattened-out' manner.

Since:

3.0

Author:

Chris Beams, Juergen Hoeller, Phillip Webb

See Also:

BeanMethod, ConfigurationClassParser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ConfigurationClass.FinalConfigurationProblem Configuration classes must be non-final to accommodate CGLIB subclassing.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<BeanMethod>	beanMethods
private java.lang.String	beanName
private java.util.Map<ImportBeanDefinitionRegistrar,AnnotationMetadata>	importBeanDefinitionRegistrars
private java.util.Set<ConfigurationClass>	importedBy
private java.util.Map<java.lang.String,java.lang.Class<? extends BeanDefinitionReader>>	importedResources
private AnnotationMetadata	metadata
private Resource	resource
(package private) java.util.Set<java.lang.String>	skippedBeanMethods

Constructor Summary

Constructors

Constructor and Description
ConfigurationClass(AnnotationMetadata metadata, java.lang.String beanName) Create a new ConfigurationClass with the given name.
ConfigurationClass(java.lang.Class<?> clazz, ConfigurationClass importedBy) Create a new ConfigurationClass representing a class that was imported using the Import annotation or automatically processed as a nested configuration class (if imported is true).
ConfigurationClass(java.lang.Class<?> clazz, java.lang.String beanName) Create a new ConfigurationClass with the given name.
ConfigurationClass(MetadataReader metadataReader, ConfigurationClass importedBy) Create a new ConfigurationClass representing a class that was imported using the Import annotation or automatically processed as a nested configuration class (if importedBy is not null).
ConfigurationClass(MetadataReader metadataReader, java.lang.String beanName) Create a new ConfigurationClass with the given name.

Method Summary

Modifier and Type	Method and Description
void	addBeanMethod(BeanMethod method)
void	addImportBeanDefinitionRegistrar(ImportBeanDefinitionRegistrar registrar, AnnotationMetadata importingClassMetadata)
void	addImportedResource(java.lang.String importedResource, java.lang.Class<? extends BeanDefinitionReader> readerClass)
boolean	equals(java.lang.Object other)
java.util.Set<BeanMethod>	getBeanMethods()
java.lang.String	getBeanName()
java.util.Map<ImportBeanDefinitionRegistrar,AnnotationMetadata>	getImportBeanDefinitionRegistrars()
java.util.Set<ConfigurationClass>	getImportedBy() Return the configuration classes that imported this class, or an empty Set if this configuration was not imported.
java.util.Map<java.lang.String,java.lang.Class<? extends BeanDefinitionReader>>	getImportedResources()
AnnotationMetadata	getMetadata()
Resource	getResource()
java.lang.String	getSimpleName()
int	hashCode()
boolean	isImported() Return whether this configuration class was registered via @Import or automatically registered due to being nested within another configuration class.
void	mergeImportedBy(ConfigurationClass otherConfigClass) Merge the imported-by declarations from the given configuration class into this one.
void	setBeanName(java.lang.String beanName)
java.lang.String	toString()
void	validate(ProblemReporter problemReporter)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

metadata

private final AnnotationMetadata metadata

resource

private final Resource resource

beanName

private java.lang.String beanName

importedBy

private final java.util.Set<ConfigurationClass> importedBy

beanMethods

private final java.util.Set<BeanMethod> beanMethods

importedResources

private final java.util.Map<java.lang.String,java.lang.Class<? extends BeanDefinitionReader>> importedResources

importBeanDefinitionRegistrars

private final java.util.Map<ImportBeanDefinitionRegistrar,AnnotationMetadata> importBeanDefinitionRegistrars

skippedBeanMethods

final java.util.Set<java.lang.String> skippedBeanMethods

Constructor Detail

ConfigurationClass

public ConfigurationClass(MetadataReader metadataReader,
                          java.lang.String beanName)

Create a new ConfigurationClass with the given name.

Parameters:

metadataReader - reader used to parse the underlying Class

beanName - must not be null

See Also:

ConfigurationClass(Class, ConfigurationClass)

ConfigurationClass

public ConfigurationClass(MetadataReader metadataReader,
                          ConfigurationClass importedBy)

Create a new ConfigurationClass representing a class that was imported using the Import annotation or automatically processed as a nested configuration class (if importedBy is not null).

Parameters:

metadataReader - reader used to parse the underlying Class

importedBy - the configuration class importing this one or null

Since:

3.1.1

ConfigurationClass

public ConfigurationClass(java.lang.Class<?> clazz,
                          java.lang.String beanName)

Create a new ConfigurationClass with the given name.

Parameters:

clazz - the underlying Class to represent

beanName - name of the @Configuration class bean

See Also:

ConfigurationClass(Class, ConfigurationClass)

ConfigurationClass

public ConfigurationClass(java.lang.Class<?> clazz,
                          ConfigurationClass importedBy)

Create a new ConfigurationClass representing a class that was imported using the Import annotation or automatically processed as a nested configuration class (if imported is true).

Parameters:

clazz - the underlying Class to represent

importedBy - the configuration class importing this one or null

Since:

3.1.1

ConfigurationClass

public ConfigurationClass(AnnotationMetadata metadata,
                          java.lang.String beanName)

Create a new ConfigurationClass with the given name.

Parameters:

metadata - the metadata for the underlying class to represent

beanName - name of the @Configuration class bean

See Also:

ConfigurationClass(Class, ConfigurationClass)

Method Detail

getMetadata

public AnnotationMetadata getMetadata()

getResource

public Resource getResource()

getSimpleName

public java.lang.String getSimpleName()

setBeanName

public void setBeanName(java.lang.String beanName)

getBeanName

public java.lang.String getBeanName()

isImported

public boolean isImported()

Return whether this configuration class was registered via @Import or automatically registered due to being nested within another configuration class.

Since:

3.1.1

See Also:

getImportedBy()

mergeImportedBy

public void mergeImportedBy(ConfigurationClass otherConfigClass)

Merge the imported-by declarations from the given configuration class into this one.

Since:

4.0.5

getImportedBy

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

Return the configuration classes that imported this class, or an empty Set if this configuration was not imported.

Since:

4.0.5

See Also:

isImported()

addBeanMethod

public void addBeanMethod(BeanMethod method)

getBeanMethods

public java.util.Set<BeanMethod> getBeanMethods()

addImportedResource

public void addImportedResource(java.lang.String importedResource,
                                java.lang.Class<? extends BeanDefinitionReader> readerClass)

addImportBeanDefinitionRegistrar

public void addImportBeanDefinitionRegistrar(ImportBeanDefinitionRegistrar registrar,
                                             AnnotationMetadata importingClassMetadata)

getImportBeanDefinitionRegistrars

public java.util.Map<ImportBeanDefinitionRegistrar,AnnotationMetadata> getImportBeanDefinitionRegistrars()

getImportedResources

public java.util.Map<java.lang.String,java.lang.Class<? extends BeanDefinitionReader>> getImportedResources()

validate

public void validate(ProblemReporter problemReporter)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object