Skip to content

Commit 08e2cab

Browse files
committed
Polish javadoc for when to use class names rather than class references
See gh-48395
1 parent 15ede46 commit 08e2cab

File tree

9 files changed

+56
-56
lines changed

9 files changed

+56
-56
lines changed

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfiguration.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@
8080
* The auto-configuration classes that should have not yet been applied.
8181
* <p>
8282
* Since this annotation is parsed by loading class bytecode, it is safe to specify
83-
* classes here that may ultimately not be on the classpath, only if this annotation
84-
* is directly on the affected component and <b>not</b> if this annotation is used as
85-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
86-
* only use the {@link #beforeName} attribute.
83+
* classes here that may ultimately not be on the classpath, but only if this
84+
* annotation is directly on the affected component and <b>not</b> if this annotation
85+
* is used as a composed, meta-annotation. In order to use this annotation as a
86+
* meta-annotation, only use the {@link #beforeName} attribute.
8787
* @return the classes
8888
*/
8989
@AliasFor(annotation = AutoConfigureBefore.class, attribute = "value")
@@ -103,10 +103,10 @@
103103
* The auto-configuration classes that should have already been applied.
104104
* <p>
105105
* Since this annotation is parsed by loading class bytecode, it is safe to specify
106-
* classes here that may ultimately not be on the classpath, only if this annotation
107-
* is directly on the affected component and <b>not</b> if this annotation is used as
108-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
109-
* only use the {@link #afterName} attribute.
106+
* classes here that may ultimately not be on the classpath, but only if this
107+
* annotation is directly on the affected component and <b>not</b> if this annotation
108+
* is used as a composed, meta-annotation. In order to use this annotation as a
109+
* meta-annotation, only use the {@link #afterName} attribute.
110110
* @return the classes
111111
*/
112112
@AliasFor(annotation = AutoConfigureAfter.class, attribute = "value")

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureAfter.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@
4747
* The auto-configuration classes that should have already been applied.
4848
* <p>
4949
* Since this annotation is parsed by loading class bytecode, it is safe to specify
50-
* classes here that may ultimately not be on the classpath, only if this annotation
51-
* is directly on the affected component and <b>not</b> if this annotation is used as
52-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
53-
* only use the {@link #name} attribute.
50+
* classes here that may ultimately not be on the classpath, but only if this
51+
* annotation is directly on the affected component and <b>not</b> if this annotation
52+
* is used as a composed, meta-annotation. In order to use this annotation as a
53+
* meta-annotation, only use the {@link #name} attribute.
5454
* @return the classes
5555
*/
5656
Class<?>[] value() default {};

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/AutoConfigureBefore.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@
4747
* The auto-configuration classes that should have not yet been applied.
4848
* <p>
4949
* Since this annotation is parsed by loading class bytecode, it is safe to specify
50-
* classes here that may ultimately not be on the classpath, only if this annotation
51-
* is directly on the affected component and <b>not</b> if this annotation is used as
52-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
53-
* only use the {@link #name} attribute.
50+
* classes here that may ultimately not be on the classpath, but only if this
51+
* annotation is directly on the affected component and <b>not</b> if this annotation
52+
* is used as a composed, meta-annotation. In order to use this annotation as a
53+
* meta-annotation, only use the {@link #name} attribute.
5454
* @return the classes
5555
*/
5656
Class<?>[] value() default {};

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/EnableAutoConfiguration.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@
9292
* Exclude specific auto-configuration classes such that they will never be applied.
9393
* <p>
9494
* Since this annotation is parsed by loading class bytecode, it is safe to specify
95-
* classes here that may ultimately not be on the classpath, only if this annotation
96-
* is directly on the affected component and <b>not</b> if this annotation is used as
97-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
98-
* only use the {@link #excludeName()} attribute.
95+
* classes here that may ultimately not be on the classpath, but only if this
96+
* annotation is directly on the affected component and <b>not</b> if this annotation
97+
* is used as a composed, meta-annotation. In order to use this annotation as a
98+
* meta-annotation, only use the {@link #excludeName()} attribute.
9999
* @return the classes to exclude
100100
*/
101101
Class<?>[] exclude() default {};

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@
6161
* Exclude specific auto-configuration classes such that they will never be applied.
6262
* <p>
6363
* Since this annotation is parsed by loading class bytecode, it is safe to specify
64-
* classes here that may ultimately not be on the classpath, only if this annotation
65-
* is directly on the affected component and <b>not</b> if this annotation is used as
66-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
67-
* only use the {@link #excludeName} attribute.
64+
* classes here that may ultimately not be on the classpath, but only if this
65+
* annotation is directly on the affected component and <b>not</b> if this annotation
66+
* is used as a composed, meta-annotation. In order to use this annotation as a
67+
* meta-annotation, only use the {@link #excludeName} attribute.
6868
* @return the classes to exclude
6969
*/
7070
@AliasFor(annotation = EnableAutoConfiguration.class)

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@
7474
* not autowire candidates or that are not default candidates are ignored.
7575
* <p>
7676
* Since this annotation is parsed by loading class bytecode, it is safe to specify
77-
* classes here that may ultimately not be on the classpath, only if this annotation
78-
* is directly on the affected component and <b>not</b> if this annotation is used as
79-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
80-
* only use the {@link #type} attribute.
77+
* classes here that may ultimately not be on the classpath, but only if this
78+
* annotation is directly on the affected component and <b>not</b> if this annotation
79+
* is used as a composed, meta-annotation. In order to use this annotation as a
80+
* meta-annotation, only use the {@link #type} attribute.
8181
* @return the class types of beans to check
8282
* @see Bean#autowireCandidate()
8383
* @see BeanDefinition#isAutowireCandidate
@@ -105,9 +105,9 @@
105105
* ignored.
106106
* <p>
107107
* Since this annotation is parsed by loading class bytecode, it is safe to specify
108-
* classes here that may ultimately not be on the classpath, only if this annotation
109-
* is directly on the affected component and <b>not</b> if this annotation is used as
110-
* a composed, meta-annotation.
108+
* classes here that may ultimately not be on the classpath, but only if this
109+
* annotation is directly on the affected component and <b>not</b> if this annotation
110+
* is used as a composed, meta-annotation.
111111
* @return the class-level annotation types to check
112112
* @see Bean#autowireCandidate()
113113
* @see BeanDefinition#isAutowireCandidate
@@ -137,9 +137,9 @@
137137
* {@code Name} and {@code NameRegistration<Name>}.
138138
* <p>
139139
* Since this annotation is parsed by loading class bytecode, it is safe to specify
140-
* classes here that may ultimately not be on the classpath, only if this annotation
141-
* is directly on the affected component and <b>not</b> if this annotation is used as
142-
* a composed, meta-annotation.
140+
* classes here that may ultimately not be on the classpath, but only if this
141+
* annotation is directly on the affected component and <b>not</b> if this annotation
142+
* is used as a composed, meta-annotation.
143143
* @return the container types
144144
* @since 2.1.0
145145
*/

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnClass.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@
6969
* The classes that must be present.
7070
* <p>
7171
* Since this annotation is parsed by loading class bytecode, it is safe to specify
72-
* classes here that may ultimately not be on the classpath, only if this annotation
73-
* is directly on the affected component and <b>not</b> if this annotation is used as
74-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
75-
* only use the {@link #name} attribute.
72+
* classes here that may ultimately not be on the classpath, but only if this
73+
* annotation is directly on the affected component and <b>not</b> if this annotation
74+
* is used as a composed, meta-annotation. In order to use this annotation as a
75+
* meta-annotation, only use the {@link #name} attribute.
7676
* @return the classes that must be present
7777
*/
7878
Class<?>[] value() default {};

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@
7575
* autowire candidates or that are not default candidates are ignored.
7676
* <p>
7777
* Since this annotation is parsed by loading class bytecode, it is safe to specify
78-
* classes here that may ultimately not be on the classpath, only if this annotation
79-
* is directly on the affected component and <b>not</b> if this annotation is used as
80-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
81-
* only use the {@link #type} attribute.
78+
* classes here that may ultimately not be on the classpath, but only if this
79+
* annotation is directly on the affected component and <b>not</b> if this annotation
80+
* is used as a composed, meta-annotation. In order to use this annotation as a
81+
* meta-annotation, only use the {@link #type} attribute.
8282
* @return the class types of beans to check
8383
* @see Bean#autowireCandidate()
8484
* @see BeanDefinition#isAutowireCandidate
@@ -103,10 +103,10 @@
103103
* The class types of beans that should be ignored when identifying matching beans.
104104
* <p>
105105
* Since this annotation is parsed by loading class bytecode, it is safe to specify
106-
* classes here that may ultimately not be on the classpath, only if this annotation
107-
* is directly on the affected component and <b>not</b> if this annotation is used as
108-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
109-
* only use the {@link #ignoredType} attribute.
106+
* classes here that may ultimately not be on the classpath, but only if this
107+
* annotation is directly on the affected component and <b>not</b> if this annotation
108+
* is used as a composed, meta-annotation. In order to use this annotation as a
109+
* meta-annotation, only use the {@link #ignoredType} attribute.
110110
* @return the class types of beans to ignore
111111
* @since 1.2.5
112112
*/
@@ -127,9 +127,9 @@
127127
* candidates are ignored.
128128
* <p>
129129
* Since this annotation is parsed by loading class bytecode, it is safe to specify
130-
* classes here that may ultimately not be on the classpath, only if this annotation
131-
* is directly on the affected component and <b>not</b> if this annotation is used as
132-
* a composed, meta-annotation.
130+
* classes here that may ultimately not be on the classpath, but only if this
131+
* annotation is directly on the affected component and <b>not</b> if this annotation
132+
* is used as a composed, meta-annotation.
133133
* @return the class-level annotation types to check
134134
* @see Bean#autowireCandidate()
135135
* @see BeanDefinition#isAutowireCandidate
@@ -159,9 +159,9 @@
159159
* {@code Name} and {@code NameRegistration<Name>}.
160160
* <p>
161161
* Since this annotation is parsed by loading class bytecode, it is safe to specify
162-
* classes here that may ultimately not be on the classpath, only if this annotation
163-
* is directly on the affected component and <b>not</b> if this annotation is used as
164-
* a composed, meta-annotation.
162+
* classes here that may ultimately not be on the classpath, but only if this
163+
* annotation is directly on the affected component and <b>not</b> if this annotation
164+
* is used as a composed, meta-annotation.
165165
* @return the container types
166166
* @since 2.1.0
167167
*/

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@
5858
* are not default candidates, or that are fallback candidates are ignored.
5959
* <p>
6060
* Since this annotation is parsed by loading class bytecode, it is safe to specify
61-
* classes here that may ultimately not be on the classpath, only if this annotation
62-
* is directly on the affected component and <b>not</b> if this annotation is used as
63-
* a composed, meta-annotation. In order to use this annotation as a meta-annotation,
64-
* only use the {@link #type} attribute.
61+
* classes here that may ultimately not be on the classpath, but only if this
62+
* annotation is directly on the affected component and <b>not</b> if this annotation
63+
* is used as a composed, meta-annotation. In order to use this annotation as a
64+
* meta-annotation, only use the {@link #type} attribute.
6565
* <p>
6666
* This attribute may <strong>not</strong> be used in conjunction with
6767
* {@link #type()}, but it may be used instead of {@link #type()}.

0 commit comments

Comments
 (0)