Skip to content

Commit c112bb0

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-beans
See gh-28803
1 parent 165fba8 commit c112bb0

29 files changed

+39
-39
lines changed

spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ public interface BeanWrapper extends ConfigurablePropertyAccessor {
8282
* Obtain the property descriptor for a specific property
8383
* of the wrapped object.
8484
* @param propertyName the property to obtain the descriptor for
85-
* (may be a nested path, but no indexed/mapped property)
85+
* (may be a nested path, but not an indexed/mapped property)
8686
* @return the property descriptor for the specified property
8787
* @throws InvalidPropertyException if there is no such property
8888
*/

spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ public boolean isEmpty() {
327327
/**
328328
* Register the specified property as "processed" in the sense
329329
* of some processor calling the corresponding setter method
330-
* outside of the PropertyValue(s) mechanism.
330+
* outside the PropertyValue(s) mechanism.
331331
* <p>This will lead to {@code true} being returned from
332332
* a {@link #contains} call for the specified property.
333333
* @param propertyName the name of the property.

spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* {@link org.springframework.beans.PropertyEditorRegistry property editor registry}.
2323
*
2424
* <p>This is particularly useful when you need to use the same set of
25-
* property editors in several different situations: write a corresponding
25+
* property editors in several situations: write a corresponding
2626
* registrar and reuse that in each case.
2727
*
2828
* @author Juergen Hoeller

spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
*
4646
* <p><b>The container is only responsible for managing the lifecycle of the FactoryBean
4747
* instance, not the lifecycle of the objects created by the FactoryBean.</b> Therefore,
48-
* a destroy method on an exposed bean object (such as {@link java.io.Closeable#close()}
48+
* a destroy method on an exposed bean object (such as {@link java.io.Closeable#close()})
4949
* will <i>not</i> be called automatically. Instead, a FactoryBean should implement
5050
* {@link DisposableBean} and delegate any such close call to the underlying object.
5151
*
@@ -108,7 +108,7 @@ public interface FactoryBean<T> {
108108
* been fully initialized. It must not rely on state created during
109109
* initialization; of course, it can still use such state if available.
110110
* <p><b>NOTE:</b> Autowiring will simply ignore FactoryBeans that return
111-
* {@code null} here. Therefore it is highly recommended to implement
111+
* {@code null} here. Therefore, it is highly recommended to implement
112112
* this method properly, using the current state of the FactoryBean.
113113
* @return the type of object that this FactoryBean creates,
114114
* or {@code null} if not known at the time of the call

spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ <T> Map<String, T> getBeansOfType(@Nullable Class<T> type, boolean includeNonSin
343343

344344
/**
345345
* Find an {@link Annotation} of {@code annotationType} on the specified bean,
346-
* traversing its interfaces and super classes if no annotation can be found on
346+
* traversing its interfaces and superclasses if no annotation can be found on
347347
* the given class itself, as well as checking the bean's factory method (if any).
348348
* @param beanName the name of the bean to look for annotations on
349349
* @param annotationType the type of annotation to look for
@@ -361,7 +361,7 @@ <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotati
361361

362362
/**
363363
* Find an {@link Annotation} of {@code annotationType} on the specified bean,
364-
* traversing its interfaces and super classes if no annotation can be found on
364+
* traversing its interfaces and superclasses if no annotation can be found on
365365
* the given class itself, as well as checking the bean's factory method (if any).
366366
* @param beanName the name of the bean to look for annotations on
367367
* @param annotationType the type of annotation to look for

spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* (possibly shared or independent) when invoked.
2424
*
2525
* <p>This interface is typically used to encapsulate a generic factory which
26-
* returns a new instance (prototype) of some target object on each invocation.
26+
* returns a new instance (prototype) of some target objects on each invocation.
2727
*
2828
* <p>This interface is similar to {@link FactoryBean}, but implementations
2929
* of the latter are normally meant to be defined as SPI instances in a

spring-beans/src/main/java/org/springframework/beans/factory/annotation/QualifierAnnotationAutowireCandidateResolver.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ public void setValueAnnotationType(Class<? extends Annotation> valueAnnotationTy
137137
* as a <em>qualifier</em>, the bean must 'match' against the annotation as
138138
* well as any attributes it may contain. The bean definition must contain
139139
* the same qualifier or match by meta attributes. A "value" attribute will
140-
* fallback to match against the bean name or an alias if a qualifier or
140+
* fall back to match against the bean name or an alias if a qualifier or
141141
* attribute does not match.
142142
* @see Qualifier
143143
*/
@@ -186,7 +186,7 @@ protected boolean checkQualifiers(BeanDefinitionHolder bdHolder, Annotation[] an
186186
if (isQualifier(metaType)) {
187187
foundMeta = true;
188188
// Only accept fallback match if @Qualifier annotation has a value...
189-
// Otherwise it is just a marker for a custom qualifier annotation.
189+
// Otherwise, it is just a marker for a custom qualifier annotation.
190190
if ((fallbackToMeta && ObjectUtils.isEmpty(AnnotationUtils.getValue(metaAnn))) ||
191191
!checkQualifier(bdHolder, metaAnn, typeConverter)) {
192192
return false;

spring-beans/src/main/java/org/springframework/beans/factory/config/BeanFactoryPostProcessor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
*
3131
* <p>A {@code BeanFactoryPostProcessor} may interact with and modify bean
3232
* definitions, but never bean instances. Doing so may cause premature bean
33-
* instantiation, violating the container and causing unintended side-effects.
33+
* instantiation, violating the container and causing unintended side effects.
3434
* If bean instance interaction is required, consider implementing
3535
* {@link BeanPostProcessor} instead.
3636
*

spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public ConstructorArgumentValues(ConstructorArgumentValues original) {
6565

6666
/**
6767
* Copy all given argument values into this object, using separate holder
68-
* instances to keep the values independent from the original object.
68+
* instances to keep the values independent of the original object.
6969
* <p>Note: Identical ValueHolder instances will only be registered once,
7070
* to allow for merging and re-merging of argument value definitions. Distinct
7171
* ValueHolder instances carrying the same content are of course allowed.

spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ public void setSupportedTypes(Class<?>... supportedTypes) {
155155
* resources. Each resource is parsed in turn and the documents inside checked against
156156
* the {@link #setDocumentMatchers(DocumentMatcher...) matchers}. If a document
157157
* matches it is passed into the callback, along with its representation as Properties.
158-
* Depending on the {@link #setResolutionMethod(ResolutionMethod)} not all of the
158+
* Depending on the {@link #setResolutionMethod(ResolutionMethod)} not all the
159159
* documents will be parsed.
160160
* @param callback a callback to delegate to once matching documents are found
161161
* @see #createYaml()

0 commit comments

Comments
 (0)