org.springframework.boot.context.annotation

Interface DeterminableImports

  • Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.


    @FunctionalInterface
    public interface DeterminableImports
    Interface that can be implemented by ImportSelector and ImportBeanDefinitionRegistrar implementations when they can determine imports early. The ImportSelector and ImportBeanDefinitionRegistrar interfaces are quite flexible which can make it hard to tell exactly what bean definitions they will add. This interface should be used when an implementation consistently results in the same imports, given the same source.

    Using DeterminableImports is particularly useful when working with Spring's testing support. It allows for better generation of ApplicationContext cache keys.

    Since:
    1.5.0
    Author:
    Phillip Webb, Andy Wilkinson
    • Method Detail

      • determineImports

        Set<Object> determineImports(AnnotationMetadata metadata)
        Return a set of objects that represent the imports. Objects within the returned Set must implement a valid hashCode and equals.

        Imports from multiple DeterminableImports instances may be combined by the caller to create a complete set.

        Unlike ImportSelector and ImportBeanDefinitionRegistrar any Aware callbacks will not be invoked before this method is called.

        Parameters:
        metadata - the source meta-data
        Returns:
        a key representing the annotations that actually drive the import