Package org.springframework.data.aot

Interface AotContext

All Known Subinterfaces:

AotRepositoryContext

public interface AotContext

The context in which the AOT processing happens. Grants access to the beanFactory and ClassLoader. Holds a few convenience methods to check if a type is present and allows resolution of them through AotContext.TypeIntrospector and AotContext.IntrospectedBeanDefinition.

Mainly for internal use within the framework.

Since:

3.0

Author:

Christoph Strobl, John Blum, Mark Paluch

See Also:

• BeanFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AotContext.IntrospectedBeanDefinition	Interface defining introspection methods for bean definitions.
static interface	AotContext.TypeIntrospector	Type-based introspector to resolve Class from a type name and to introspect the bean factory for presence of beans.

Method Summary

Modifier and Type	Method	Description
static AotContext	from(BeanFactory beanFactory)	Create an AotContext backed by the given BeanFactory.
ConfigurableListableBeanFactory	getBeanFactory()	Returns a reference to the ConfigurableListableBeanFactory backing this AotContext.
default ClassLoader	getClassLoader()	Returns the ClassLoader used by this AotContext to resolve types.
default ClassLoader	getRequiredClassLoader()	Returns the required ClassLoader used by this AotContext to resolve types.
default TypeScanner	getTypeScanner()	Returns a new TypeScanner used to scan for types that will be contributed to the AOT processing infrastructure.
AotContext.IntrospectedBeanDefinition	introspectBeanDefinition(String beanName)	Returns a AotContext.IntrospectedBeanDefinition to obtain further detail about the underlying bean definition.
default AotContext.IntrospectedBeanDefinition	introspectBeanDefinition(BeanReference reference)	Returns a AotContext.IntrospectedBeanDefinition to obtain further detail about the underlying bean definition.
AotContext.TypeIntrospector	introspectType(String typeName)	Returns a AotContext.TypeIntrospector to obtain further detail about a type given its fully-qualified type name
default Set<Class<?>>	scanPackageForTypes(Collection<Class<? extends Annotation>> identifyingAnnotations, Collection<String> packageNames)	Scans for types in the given named packages annotated with the store-specific identifying annotations.

Method Details

from

static AotContext from(BeanFactory beanFactory)

Create an AotContext backed by the given BeanFactory.

Parameters:

beanFactory - reference to the BeanFactory; must not be null.

Returns:

a new instance of AotContext.

See Also:

• BeanFactory

getBeanFactory

ConfigurableListableBeanFactory getBeanFactory()

Returns a reference to the ConfigurableListableBeanFactory backing this AotContext.

Returns:

a reference to the ConfigurableListableBeanFactory backing this AotContext.

See Also:

• ConfigurableListableBeanFactory

getClassLoader

@Nullable
default ClassLoader getClassLoader()

Returns the ClassLoader used by this AotContext to resolve types. By default, this is the same ClassLoader used by the BeanFactory to resolve types declared in bean definitions.

Returns:

the ClassLoader used by this AotContext to resolve types.

See Also:

• ConfigurableBeanFactory.getBeanClassLoader()

getRequiredClassLoader

default ClassLoader getRequiredClassLoader()

Returns the required ClassLoader used by this AotContext to resolve types. By default, this is the same ClassLoader used by the BeanFactory to resolve types declared in bean definitions.

Returns:

the ClassLoader used by this AotContext to resolve types.

Throws:

IllegalStateException - if no ClassLoader is available.

introspectType

AotContext.TypeIntrospector introspectType(String typeName)

Returns a AotContext.TypeIntrospector to obtain further detail about a type given its fully-qualified type name

Parameters:

typeName - name of the type to evaluate; must not be null.

Returns:

the type introspector for further type-based introspection.

getTypeScanner

default TypeScanner getTypeScanner()

Returns a new TypeScanner used to scan for types that will be contributed to the AOT processing infrastructure.

Returns:

a TypeScanner used to scan for types that will be contributed to the AOT processing infrastructure.

See Also:

• TypeScanner

scanPackageForTypes

default Set<Class<?>> scanPackageForTypes(Collection<Class<? extends Annotation>> identifyingAnnotations,
 Collection<String> packageNames)

Scans for types in the given named packages annotated with the store-specific identifying annotations.

Parameters:

identifyingAnnotations - Collection of Annotations identifying store-specific model types; must not be null.

packageNames - Collection of package names to scan.

Returns:

a Set of types found during the scan.

See Also:

• getTypeScanner()

introspectBeanDefinition

default AotContext.IntrospectedBeanDefinition introspectBeanDefinition(BeanReference reference)

Returns a AotContext.IntrospectedBeanDefinition to obtain further detail about the underlying bean definition. A introspected bean definition can also point to an absent bean definition.

Parameters:

reference - BeanReference to the managed bean.

Returns:

the introspected bean definition.

introspectBeanDefinition

AotContext.IntrospectedBeanDefinition introspectBeanDefinition(String beanName)

Returns a AotContext.IntrospectedBeanDefinition to obtain further detail about the underlying bean definition. A introspected bean definition can also point to an absent bean definition.

Parameters:

beanName - String containing the name of the bean to evaluate; must not be null.

Returns:

the introspected bean definition.