Rename @ConfigurationPropertiesImport

Rename `@ConfigurationPropertiesImport` to
`@ImportAsConfigurationPropertiesBean` and also refine the registrar
so that it can be used with type directly annotated with
`@ConfigurationProperties`.

Closes gh-23172

Author: philwebb

spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc

@@ -1227,7 +1227,7 @@ Spring Boot provides infrastructure to bind `@ConfigurationProperties` types and
 You can either enable configuration properties on a class-by-class basis or enable configuration property scanning that works in a similar manner to component scanning.
 
 Sometimes, classes annotated with `@ConfigurationProperties` might not be suitable for scanning, for example, if you're developing your own auto-configuration or you want to enable them conditionally.
-In these cases, specify the list of types to process using the `@EnableConfigurationProperties` or `@ConfigurationPropertiesImport` annotations.
+In these cases, specify the list of types to process using the `@EnableConfigurationProperties` or `@ImportAsConfigurationPropertiesBean` annotations.
 This can be done on any `@Configuration` class, as shown in the following example:
 
 [source,java,indent=0]
@@ -1253,7 +1253,7 @@ If you want to define specific packages to scan, you can do so as shown in the f
 
 [NOTE]
 ====
-When the `@ConfigurationProperties` bean is registered using configuration property scanning or via `@EnableConfigurationProperties` or `@ConfigurationPropertiesImport`, the bean has a conventional name: `<prefix>-<fqn>`, where `<prefix>` is the environment key prefix specified in the `@ConfigurationProperties` annotation and `<fqn>` is the fully qualified name of the bean.
+When the `@ConfigurationProperties` bean is registered using configuration property scanning or via `@EnableConfigurationProperties` or `@ImportAsConfigurationPropertiesBean`, the bean has a conventional name: `<prefix>-<fqn>`, where `<prefix>` is the environment key prefix specified in the `@ConfigurationProperties` annotation and `<fqn>` is the fully qualified name of the bean.
 If the annotation does not provide any prefix, only the fully qualified name of the bean is used.
 
 The bean name in the example above is `acme-com.example.AcmeProperties`.
@@ -1333,18 +1333,18 @@ To configure a bean from the `Environment` properties, add `@ConfigurationProper
 Any JavaBean property defined with the `another` prefix is mapped onto that `ExampleItem` bean in manner similar to the preceding `AcmeProperties` example.
 
 If you want to use constructor binding with a third-party class, you can't use a `@Bean` method since Spring will need to create the object instance.
-For those situations, you can use an `@ConfigurationPropertiesImport` annotation on your `@Configuration` or `@SpringBootApplication` class.
+For those situations, you can use an `@ImportAsConfigurationPropertiesBean` annotation on your `@Configuration` or `@SpringBootApplication` class.
 
 [source,java,indent=0]
 ----
 	@SpringBootApplication
-	@ConfigurationPropertiesImport(type = ExampleItem.class, prefix = "another")
+	@ImportAsConfigurationPropertiesBean(type = ExampleItem.class, prefix = "another")
 	public class MyApp {
 		...
 	}
 ----
 
-TIP: `@ConfigurationPropertiesImport` also works for JavaBean bindings as long as the type has a single no-arg constructor
+TIP: `@ImportAsConfigurationPropertiesBean` also works for JavaBean bindings as long as the type has a single no-arg constructor
 
 
 

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java

@@ -80,9 +80,9 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
 
 	static final String NAME_ANNOTATION = "org.springframework.boot.context.properties.bind.Name";
 
-	static final String CONFIGURATION_PROPERTIES_IMPORT_ANNOATION = "org.springframework.boot.context.properties.ConfigurationPropertiesImport";
+	static final String IMPORT_AS_CONFIGURATION_PROPERTIES_BEAN_ANNOATION = "org.springframework.boot.context.properties.ImportAsConfigurationPropertiesBean";
 
-	static final String CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION = "org.springframework.boot.context.properties.ConfigurationPropertiesImports";
+	static final String IMPORT_AS_CONFIGURATION_PROPERTIES_BEANS_ANNOATION = "org.springframework.boot.context.properties.ImportAsConfigurationPropertiesBeans";
 
 	private static final Set<String> SUPPORTED_OPTIONS = Collections
 			.unmodifiableSet(Collections.singleton(ADDITIONAL_METADATA_LOCATIONS_OPTION));
@@ -125,12 +125,12 @@ protected String nameAnnotation() {
 		return NAME_ANNOTATION;
 	}
 
-	protected String configurationPropertiesImportAnnotation() {
-		return CONFIGURATION_PROPERTIES_IMPORT_ANNOATION;
+	protected String importAsConfigurationPropertiesBeanAnnotation() {
+		return IMPORT_AS_CONFIGURATION_PROPERTIES_BEAN_ANNOATION;
 	}
 
-	protected String configurationPropertiesImportsAnnotation() {
-		return CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION;
+	protected String importAsConfigurationPropertiesBeansAnnotation() {
+		return IMPORT_AS_CONFIGURATION_PROPERTIES_BEANS_ANNOATION;
 	}
 
 	@Override
@@ -151,16 +151,16 @@ public synchronized void init(ProcessingEnvironment env) {
 		this.metadataEnv = new MetadataGenerationEnvironment(env, configurationPropertiesAnnotation(),
 				nestedConfigurationPropertyAnnotation(), deprecatedConfigurationPropertyAnnotation(),
 				constructorBindingAnnotation(), defaultValueAnnotation(), endpointAnnotation(),
-				readOperationAnnotation(), nameAnnotation(), configurationPropertiesImportAnnotation(),
-				configurationPropertiesImportsAnnotation());
+				readOperationAnnotation(), nameAnnotation(), importAsConfigurationPropertiesBeanAnnotation(),
+				importAsConfigurationPropertiesBeansAnnotation());
 	}
 
 	@Override
 	public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
 		this.metadataCollector.processing(roundEnv);
 		processConfigurationProperties(roundEnv);
 		processEndpoint(roundEnv);
-		processConfigurationPropertiesImport(roundEnv);
+		processImportAsConfigurationProperties(roundEnv);
 		if (roundEnv.processingOver()) {
 			try {
 				writeMetaData();
@@ -188,22 +188,22 @@ private void processEndpoint(RoundEnvironment roundEnv) {
 		}
 	}
 
-	private void processConfigurationPropertiesImport(RoundEnvironment roundEnv) {
-		TypeElement configurationPropertiesImportType = this.metadataEnv
-				.getConfigurationPropertiesImportAnnotationElement();
-		TypeElement configurationPropertiesImportsType = this.metadataEnv
-				.getConfigurationPropertiesImportsAnnotationElement();
-		if (configurationPropertiesImportType == null && configurationPropertiesImportsType == null) {
+	private void processImportAsConfigurationProperties(RoundEnvironment roundEnv) {
+		TypeElement importAsConfigurationPropertiesBeanType = this.metadataEnv
+				.getImportAsConfigurationPropertiesBeansAnnotation();
+		TypeElement importAsConfigurationPropertiesBeansType = this.metadataEnv
+				.getImportAsConfigurationPropertiesBeansAnnotationElement();
+		if (importAsConfigurationPropertiesBeanType == null && importAsConfigurationPropertiesBeansType == null) {
 			return;
 		}
 		Set<Element> elements = new LinkedHashSet<>();
-		if (configurationPropertiesImportType != null) {
-			elements.addAll(roundEnv.getElementsAnnotatedWith(configurationPropertiesImportType));
+		if (importAsConfigurationPropertiesBeanType != null) {
+			elements.addAll(roundEnv.getElementsAnnotatedWith(importAsConfigurationPropertiesBeanType));
 		}
-		if (configurationPropertiesImportsType != null) {
-			elements.addAll(roundEnv.getElementsAnnotatedWith(configurationPropertiesImportsType));
+		if (importAsConfigurationPropertiesBeansType != null) {
+			elements.addAll(roundEnv.getElementsAnnotatedWith(importAsConfigurationPropertiesBeansType));
 		}
-		elements.forEach(this::processConfigurationPropertiesImport);
+		elements.forEach(this::processImportAsConfigurationPropertiesBean);
 	}
 
 	private Map<Element, List<Element>> getElementsAnnotatedOrMetaAnnotatedWith(RoundEnvironment roundEnv,
@@ -314,18 +314,28 @@ private void processEndpoint(AnnotationMirror annotation, TypeElement element) {
 		}
 	}
 
-	private void processConfigurationPropertiesImport(Element element) {
-		this.metadataEnv.getConfigurationPropertiesImportAnnotations(element)
-				.forEach(this::processConfigurationPropertiesImport);
+	private void processImportAsConfigurationPropertiesBean(Element element) {
+		this.metadataEnv.getImportAsConfigurationPropertiesBeanAnnotations(element)
+				.forEach(this::processImportAsConfigurationPropertiesBean);
 	}
 
 	@SuppressWarnings("unchecked")
-	private void processConfigurationPropertiesImport(AnnotationMirror annotation) {
+	private void processImportAsConfigurationPropertiesBean(AnnotationMirror annotation) {
 		String prefix = getPrefix(annotation);
-		List<TypeMirror> types = (List<TypeMirror>) this.metadataEnv.getAnnotationElementValues(annotation).get("type");
-		for (TypeMirror type : types) {
-			Element element = this.metadataEnv.getTypeUtils().asElement(type);
-			processAnnotatedTypeElement(prefix, (TypeElement) element, true, new Stack<>());
+		processImportAsConfigurationPropertiesBeanTypes(prefix,
+				(List<TypeMirror>) this.metadataEnv.getAnnotationElementValues(annotation).get("type"));
+		processImportAsConfigurationPropertiesBeanTypes(prefix,
+				(List<TypeMirror>) this.metadataEnv.getAnnotationElementValues(annotation).get("value"));
+	}
+
+	private void processImportAsConfigurationPropertiesBeanTypes(String prefix, List<TypeMirror> types) {
+		if (types != null) {
+			for (TypeMirror type : types) {
+				Element element = this.metadataEnv.getTypeUtils().asElement(type);
+				AnnotationMirror annotation = this.metadataEnv.getConfigurationPropertiesAnnotation(element);
+				prefix = (annotation != null) ? getPrefix(annotation) : prefix;
+				processAnnotatedTypeElement(prefix, (TypeElement) element, true, new Stack<>());
+			}
 		}
 	}
 

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/MetadataGenerationEnvironment.java

@@ -97,15 +97,15 @@ class MetadataGenerationEnvironment {
 
 	private final String nameAnnotation;
 
-	private final String configurationPropertiesImportAnnotation;
+	private final String importAsConfigurationPropertiesBeanAnnotation;
 
-	private final String configurationPropertiesImportsAnnotation;
+	private final String importAsConfigurationPropertiesBeansAnnotation;
 
 	MetadataGenerationEnvironment(ProcessingEnvironment environment, String configurationPropertiesAnnotation,
 			String nestedConfigurationPropertyAnnotation, String deprecatedConfigurationPropertyAnnotation,
 			String constructorBindingAnnotation, String defaultValueAnnotation, String endpointAnnotation,
-			String readOperationAnnotation, String nameAnnotation, String configurationPropertiesImportAnnotation,
-			String configurationPropertiesImportsAnnotation) {
+			String readOperationAnnotation, String nameAnnotation, String importAsConfigurationPropertiesBeanAnnotation,
+			String importAsConfigurationPropertiesBeansAnnotation) {
 		this.typeUtils = new TypeUtils(environment);
 		this.elements = environment.getElementUtils();
 		this.messager = environment.getMessager();
@@ -118,8 +118,8 @@ class MetadataGenerationEnvironment {
 		this.endpointAnnotation = endpointAnnotation;
 		this.readOperationAnnotation = readOperationAnnotation;
 		this.nameAnnotation = nameAnnotation;
-		this.configurationPropertiesImportAnnotation = configurationPropertiesImportAnnotation;
-		this.configurationPropertiesImportsAnnotation = configurationPropertiesImportsAnnotation;
+		this.importAsConfigurationPropertiesBeanAnnotation = importAsConfigurationPropertiesBeanAnnotation;
+		this.importAsConfigurationPropertiesBeansAnnotation = importAsConfigurationPropertiesBeansAnnotation;
 	}
 
 	private static FieldValuesParser resolveFieldValuesParser(ProcessingEnvironment env) {
@@ -265,12 +265,12 @@ TypeElement getConfigurationPropertiesAnnotationElement() {
 		return this.elements.getTypeElement(this.configurationPropertiesAnnotation);
 	}
 
-	TypeElement getConfigurationPropertiesImportAnnotationElement() {
-		return this.elements.getTypeElement(this.configurationPropertiesImportAnnotation);
+	TypeElement getImportAsConfigurationPropertiesBeansAnnotation() {
+		return this.elements.getTypeElement(this.importAsConfigurationPropertiesBeanAnnotation);
 	}
 
-	TypeElement getConfigurationPropertiesImportsAnnotationElement() {
-		return this.elements.getTypeElement(this.configurationPropertiesImportsAnnotation);
+	TypeElement getImportAsConfigurationPropertiesBeansAnnotationElement() {
+		return this.elements.getTypeElement(this.importAsConfigurationPropertiesBeansAnnotation);
 	}
 
 	AnnotationMirror getConfigurationPropertiesAnnotation(Element element) {
@@ -297,13 +297,13 @@ AnnotationMirror getNameAnnotation(Element element) {
 		return getAnnotation(element, this.nameAnnotation);
 	}
 
-	List<AnnotationMirror> getConfigurationPropertiesImportAnnotations(Element element) {
+	List<AnnotationMirror> getImportAsConfigurationPropertiesBeanAnnotations(Element element) {
 		List<AnnotationMirror> annotations = new ArrayList<>();
-		AnnotationMirror importBean = getAnnotation(element, this.configurationPropertiesImportAnnotation);
+		AnnotationMirror importBean = getAnnotation(element, this.importAsConfigurationPropertiesBeanAnnotation);
 		if (importBean != null) {
 			annotations.add(importBean);
 		}
-		AnnotationMirror importBeans = getAnnotation(element, this.configurationPropertiesImportsAnnotation);
+		AnnotationMirror importBeans = getAnnotation(element, this.importAsConfigurationPropertiesBeansAnnotation);
 		if (importBeans != null) {
 			AnnotationValue value = importBeans.getElementValues().values().iterator().next();
 			for (Object contained : (List<?>) value.getValue()) {

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/PropertyDescriptorResolver.java

@@ -50,7 +50,7 @@ class PropertyDescriptorResolver {
 	 * factory method}, if any.
 	 * @param type the target type
 	 * @param fromImport it the type was imported via a
-	 * {@code @ConfigurationPropertiesImport}
+	 * {@code @ImportAsConfigurationPropertiesBean}
 	 * @param factoryMethod the method that triggered the metadata for that {@code type}
 	 * or {@code null}
 	 * @return the candidate properties for metadata generation

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/ImportBeanTests.java

@@ -20,20 +20,22 @@
 
 import org.springframework.boot.configurationprocessor.metadata.ConfigurationMetadata;
 import org.springframework.boot.configurationprocessor.metadata.Metadata;
-import org.springframework.boot.configurationsample.ConfigurationPropertiesImport;
-import org.springframework.boot.configurationsample.ConfigurationPropertiesImports;
+import org.springframework.boot.configurationsample.ImportAsConfigurationPropertiesBean;
+import org.springframework.boot.configurationsample.ImportAsConfigurationPropertiesBeans;
+import org.springframework.boot.configurationsample.importbean.ImportAnnotatedJavaBean;
 import org.springframework.boot.configurationsample.importbean.ImportJavaBeanConfigurationPropertiesBean;
 import org.springframework.boot.configurationsample.importbean.ImportMultipleTypeConfigurationPropertiesBean;
 import org.springframework.boot.configurationsample.importbean.ImportRepeatedConfigurationPropertiesBean;
 import org.springframework.boot.configurationsample.importbean.ImportValueObjectConfigurationPropertiesBean;
+import org.springframework.boot.configurationsample.importbean.ImportedAnnotatedJavaBean;
 import org.springframework.boot.configurationsample.importbean.ImportedJavaBean;
 import org.springframework.boot.configurationsample.importbean.ImportedValueObject;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * Tests for {@link ConfigurationPropertiesImport} and
- * {@link ConfigurationPropertiesImports}.
+ * Tests for {@link ImportAsConfigurationPropertiesBean} and
+ * {@link ImportAsConfigurationPropertiesBeans}.
  *
  * @author Phillip Webb
  */
@@ -69,4 +71,11 @@ void importRepeatedConfigurationPropertiesBean() {
 		assertThat(metadata).has(Metadata.withProperty("jb.name", String.class).fromSource(ImportedJavaBean.class));
 	}
 
+	@Test
+	void importAnnotatedJavaBean() {
+		ConfigurationMetadata metadata = compile(ImportAnnotatedJavaBean.class);
+		assertThat(metadata)
+				.has(Metadata.withProperty("test.name", String.class).fromSource(ImportedAnnotatedJavaBean.class));
+	}
+
 }

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/MetadataGenerationEnvironmentFactory.java

@@ -40,8 +40,8 @@ public MetadataGenerationEnvironment apply(ProcessingEnvironment environment) {
 				TestConfigurationMetadataAnnotationProcessor.ENDPOINT_ANNOTATION,
 				TestConfigurationMetadataAnnotationProcessor.READ_OPERATION_ANNOTATION,
 				TestConfigurationMetadataAnnotationProcessor.NAME_ANNOTATION,
-				TestConfigurationMetadataAnnotationProcessor.CONFIGURATION_PROPERTIES_IMPORT_ANNOATION,
-				TestConfigurationMetadataAnnotationProcessor.CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION);
+				TestConfigurationMetadataAnnotationProcessor.IMPORT_AS_CONFIGURATION_PROPERTIES_BEAN_ANNOATION,
+				TestConfigurationMetadataAnnotationProcessor.IMPORT_AS_CONFIGURATION_PROPERTIES_BEANS_ANNOATION);
 	}
 
 }

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationprocessor/test/TestConfigurationMetadataAnnotationProcessor.java

@@ -57,9 +57,9 @@ public class TestConfigurationMetadataAnnotationProcessor extends ConfigurationM
 
 	public static final String NAME_ANNOTATION = "org.springframework.boot.configurationsample.Name";
 
-	public static final String CONFIGURATION_PROPERTIES_IMPORT_ANNOATION = "org.springframework.boot.configurationsample.ConfigurationPropertiesImport";
+	public static final String IMPORT_AS_CONFIGURATION_PROPERTIES_BEAN_ANNOATION = "org.springframework.boot.configurationsample.ImportAsConfigurationPropertiesBean";
 
-	public static final String CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION = "org.springframework.boot.configurationsample.ConfigurationPropertiesImports";
+	public static final String IMPORT_AS_CONFIGURATION_PROPERTIES_BEANS_ANNOATION = "org.springframework.boot.configurationsample.ImportAsConfigurationPropertiesBeans";
 
 	private ConfigurationMetadata metadata;
 
@@ -110,13 +110,13 @@ protected String nameAnnotation() {
 	}
 
 	@Override
-	protected String configurationPropertiesImportAnnotation() {
-		return CONFIGURATION_PROPERTIES_IMPORT_ANNOATION;
+	protected String importAsConfigurationPropertiesBeanAnnotation() {
+		return IMPORT_AS_CONFIGURATION_PROPERTIES_BEAN_ANNOATION;
 	}
 
 	@Override
-	protected String configurationPropertiesImportsAnnotation() {
-		return CONFIGURATION_PROPERTIES_IMPORTS_ANNOATION;
+	protected String importAsConfigurationPropertiesBeansAnnotation() {
+		return IMPORT_AS_CONFIGURATION_PROPERTIES_BEANS_ANNOATION;
 	}
 
 	@Override

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ConfigurationPropertiesImport.java renamed to spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ImportAsConfigurationPropertiesBean.java

@@ -26,17 +26,17 @@
 import org.springframework.core.annotation.AliasFor;
 
 /**
- * Alternative to Spring Boot's {@code ConfigurationPropertiesImport} for testing (removes
- * the need for a dependency on the real annotation).
+ * Alternative to Spring Boot's {@code ImportAsConfigurationPropertiesBean} for testing
+ * (removes the need for a dependency on the real annotation).
  *
  * @author Phillip Webb
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @ConfigurationProperties
-@Repeatable(ConfigurationPropertiesImports.class)
-public @interface ConfigurationPropertiesImport {
+@Repeatable(ImportAsConfigurationPropertiesBeans.class)
+public @interface ImportAsConfigurationPropertiesBean {
 
 	Class<?>[] type();
 

spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ConfigurationPropertiesImports.java renamed to spring-boot-project/spring-boot-tools/spring-boot-configuration-processor/src/test/java/org/springframework/boot/configurationsample/ImportAsConfigurationPropertiesBeans.java

@@ -23,16 +23,16 @@
 import java.lang.annotation.Target;
 
 /**
- * Alternative to Spring Boot's {@code ConfigurationPropertiesImports} for testing
+ * Alternative to Spring Boot's {@code ImportAsConfigurationPropertiesBeans} for testing
  * (removes the need for a dependency on the real annotation).
  *
  * @author Phillip Webb
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
-public @interface ConfigurationPropertiesImports {
+public @interface ImportAsConfigurationPropertiesBeans {
 
-	ConfigurationPropertiesImport[] value();
+	ImportAsConfigurationPropertiesBean[] value();
 
 }