From c112bb0ae191623cfcf64e5d0ed52d38920ca1fd Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Tue, 12 Jul 2022 17:54:01 +0200 Subject: [PATCH] Fix and improve Javadoc in spring-beans See gh-28803 --- .../main/java/org/springframework/beans/BeanWrapper.java | 2 +- .../org/springframework/beans/MutablePropertyValues.java | 2 +- .../org/springframework/beans/PropertyEditorRegistrar.java | 2 +- .../java/org/springframework/beans/factory/FactoryBean.java | 4 ++-- .../springframework/beans/factory/ListableBeanFactory.java | 4 ++-- .../org/springframework/beans/factory/ObjectFactory.java | 2 +- .../QualifierAnnotationAutowireCandidateResolver.java | 4 ++-- .../beans/factory/config/BeanFactoryPostProcessor.java | 2 +- .../beans/factory/config/ConstructorArgumentValues.java | 2 +- .../springframework/beans/factory/config/YamlProcessor.java | 2 +- .../beans/factory/parsing/BeanComponentDefinition.java | 2 +- .../beans/factory/parsing/ComponentDefinition.java | 4 ++-- .../factory/support/AbstractAutowireCapableBeanFactory.java | 2 +- .../beans/factory/support/AbstractBeanDefinition.java | 4 ++-- .../beans/factory/support/AbstractBeanFactory.java | 2 +- .../beans/factory/support/BeanDefinitionBuilder.java | 2 +- .../beans/factory/support/DefaultListableBeanFactory.java | 2 +- .../support/GenericTypeAwareAutowireCandidateResolver.java | 2 +- .../beans/factory/xml/AbstractBeanDefinitionParser.java | 2 +- .../beans/factory/xml/BeanDefinitionParserDelegate.java | 4 ++-- .../beans/factory/xml/DefaultNamespaceHandlerResolver.java | 2 +- .../beans/factory/xml/DelegatingEntityResolver.java | 2 +- .../beans/factory/xml/PluggableSchemaResolver.java | 4 ++-- .../factory/xml/SimpleConstructorNamespaceHandler.java | 2 +- .../beans/factory/xml/XmlBeanDefinitionReader.java | 4 ++-- .../beans/propertyeditors/StringArrayPropertyEditor.java | 6 +++--- .../springframework/beans/propertyeditors/URIEditor.java | 2 +- .../factory/config/MethodInvokingFactoryBeanTests.java | 2 +- .../springframework/beans/testfixture/beans/ITestBean.java | 2 +- 29 files changed, 39 insertions(+), 39 deletions(-) diff --git a/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java b/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java index 90ee4f129cba..798191cc55d7 100644 --- a/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java +++ b/spring-beans/src/main/java/org/springframework/beans/BeanWrapper.java @@ -82,7 +82,7 @@ public interface BeanWrapper extends ConfigurablePropertyAccessor { * Obtain the property descriptor for a specific property * of the wrapped object. * @param propertyName the property to obtain the descriptor for - * (may be a nested path, but no indexed/mapped property) + * (may be a nested path, but not an indexed/mapped property) * @return the property descriptor for the specified property * @throws InvalidPropertyException if there is no such property */ diff --git a/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java b/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java index 97c0a0ab05b9..2cd188ca259c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java +++ b/spring-beans/src/main/java/org/springframework/beans/MutablePropertyValues.java @@ -327,7 +327,7 @@ public boolean isEmpty() { /** * Register the specified property as "processed" in the sense * of some processor calling the corresponding setter method - * outside of the PropertyValue(s) mechanism. + * outside the PropertyValue(s) mechanism. *

This will lead to {@code true} being returned from * a {@link #contains} call for the specified property. * @param propertyName the name of the property. diff --git a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java index 1d5974cfd155..69e2a68b3e3c 100644 --- a/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java +++ b/spring-beans/src/main/java/org/springframework/beans/PropertyEditorRegistrar.java @@ -22,7 +22,7 @@ * {@link org.springframework.beans.PropertyEditorRegistry property editor registry}. * *

This is particularly useful when you need to use the same set of - * property editors in several different situations: write a corresponding + * property editors in several situations: write a corresponding * registrar and reuse that in each case. * * @author Juergen Hoeller diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java b/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java index 224563cc7749..97362ce1f7c9 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/FactoryBean.java @@ -45,7 +45,7 @@ * *

The container is only responsible for managing the lifecycle of the FactoryBean * instance, not the lifecycle of the objects created by the FactoryBean. Therefore, - * a destroy method on an exposed bean object (such as {@link java.io.Closeable#close()} + * a destroy method on an exposed bean object (such as {@link java.io.Closeable#close()}) * will not be called automatically. Instead, a FactoryBean should implement * {@link DisposableBean} and delegate any such close call to the underlying object. * @@ -108,7 +108,7 @@ public interface FactoryBean { * been fully initialized. It must not rely on state created during * initialization; of course, it can still use such state if available. *

NOTE: Autowiring will simply ignore FactoryBeans that return - * {@code null} here. Therefore it is highly recommended to implement + * {@code null} here. Therefore, it is highly recommended to implement * this method properly, using the current state of the FactoryBean. * @return the type of object that this FactoryBean creates, * or {@code null} if not known at the time of the call diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java index 2642e72d7ae5..bf88c509cd71 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/ListableBeanFactory.java @@ -343,7 +343,7 @@ Map getBeansOfType(@Nullable Class type, boolean includeNonSin /** * Find an {@link Annotation} of {@code annotationType} on the specified bean, - * traversing its interfaces and super classes if no annotation can be found on + * traversing its interfaces and superclasses if no annotation can be found on * the given class itself, as well as checking the bean's factory method (if any). * @param beanName the name of the bean to look for annotations on * @param annotationType the type of annotation to look for @@ -361,7 +361,7 @@ A findAnnotationOnBean(String beanName, Class annotati /** * Find an {@link Annotation} of {@code annotationType} on the specified bean, - * traversing its interfaces and super classes if no annotation can be found on + * traversing its interfaces and superclasses if no annotation can be found on * the given class itself, as well as checking the bean's factory method (if any). * @param beanName the name of the bean to look for annotations on * @param annotationType the type of annotation to look for diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java index 9ac3ed4ab757..1ed6f2dbdb27 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/ObjectFactory.java @@ -23,7 +23,7 @@ * (possibly shared or independent) when invoked. * *

This interface is typically used to encapsulate a generic factory which - * returns a new instance (prototype) of some target object on each invocation. + * returns a new instance (prototype) of some target objects on each invocation. * *

This interface is similar to {@link FactoryBean}, but implementations * of the latter are normally meant to be defined as SPI instances in a diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/QualifierAnnotationAutowireCandidateResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/QualifierAnnotationAutowireCandidateResolver.java index e4e104b4c8e4..d7e7e45574f1 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/annotation/QualifierAnnotationAutowireCandidateResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/annotation/QualifierAnnotationAutowireCandidateResolver.java @@ -137,7 +137,7 @@ public void setValueAnnotationType(Class valueAnnotationTy * as a qualifier, the bean must 'match' against the annotation as * well as any attributes it may contain. The bean definition must contain * the same qualifier or match by meta attributes. A "value" attribute will - * fallback to match against the bean name or an alias if a qualifier or + * fall back to match against the bean name or an alias if a qualifier or * attribute does not match. * @see Qualifier */ @@ -186,7 +186,7 @@ protected boolean checkQualifiers(BeanDefinitionHolder bdHolder, Annotation[] an if (isQualifier(metaType)) { foundMeta = true; // Only accept fallback match if @Qualifier annotation has a value... - // Otherwise it is just a marker for a custom qualifier annotation. + // Otherwise, it is just a marker for a custom qualifier annotation. if ((fallbackToMeta && ObjectUtils.isEmpty(AnnotationUtils.getValue(metaAnn))) || !checkQualifier(bdHolder, metaAnn, typeConverter)) { return false; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanFactoryPostProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanFactoryPostProcessor.java index 5db855fe79e7..68c286cffb09 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanFactoryPostProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/BeanFactoryPostProcessor.java @@ -30,7 +30,7 @@ * *

A {@code BeanFactoryPostProcessor} may interact with and modify bean * definitions, but never bean instances. Doing so may cause premature bean - * instantiation, violating the container and causing unintended side-effects. + * instantiation, violating the container and causing unintended side effects. * If bean instance interaction is required, consider implementing * {@link BeanPostProcessor} instead. * diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java index c4d779e697b8..a5913f4314e3 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/ConstructorArgumentValues.java @@ -65,7 +65,7 @@ public ConstructorArgumentValues(ConstructorArgumentValues original) { /** * Copy all given argument values into this object, using separate holder - * instances to keep the values independent from the original object. + * instances to keep the values independent of the original object. *

Note: Identical ValueHolder instances will only be registered once, * to allow for merging and re-merging of argument value definitions. Distinct * ValueHolder instances carrying the same content are of course allowed. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java index 7949003c68bd..cd53b6082c6f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/config/YamlProcessor.java @@ -155,7 +155,7 @@ public void setSupportedTypes(Class... supportedTypes) { * resources. Each resource is parsed in turn and the documents inside checked against * the {@link #setDocumentMatchers(DocumentMatcher...) matchers}. If a document * matches it is passed into the callback, along with its representation as Properties. - * Depending on the {@link #setResolutionMethod(ResolutionMethod)} not all of the + * Depending on the {@link #setResolutionMethod(ResolutionMethod)} not all the * documents will be parsed. * @param callback a callback to delegate to once matching documents are found * @see #createYaml() diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java index 32305abbacc3..fd5d06080cba 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/BeanComponentDefinition.java @@ -124,7 +124,7 @@ public String toString() { } /** - * This implementations expects the other object to be of type BeanComponentDefinition + * This implementation expects the other object to be of type BeanComponentDefinition * as well, in addition to the superclass's equality requirements. */ @Override diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java index a89902539c73..33ec279f9c24 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/parsing/ComponentDefinition.java @@ -50,13 +50,13 @@ * {@link #getBeanReferences}, tools may wish to inspect all {@link BeanDefinition BeanDefinitions} to gather * the full set of {@link BeanReference BeanReferences}. Implementations are required to provide * all {@link BeanReference BeanReferences} that are required to validate the configuration of the - * overall logical entity as well as those required to provide full user visualisation of the configuration. + * overall logical entity as well as those required to provide full user visualization of the configuration. * It is expected that certain {@link BeanReference BeanReferences} will not be important to * validation or to the user view of the configuration and as such these may be omitted. A tool may wish to * display any additional {@link BeanReference BeanReferences} sourced through the supplied * {@link BeanDefinition BeanDefinitions} but this is not considered to be a typical case. * - *

Tools can determine the important of contained {@link BeanDefinition BeanDefinitions} by checking the + *

Tools can determine the importance of contained {@link BeanDefinition BeanDefinitions} by checking the * {@link BeanDefinition#getRole role identifier}. The role is essentially a hint to the tool as to how * important the configuration provider believes a {@link BeanDefinition} is to the end user. It is expected * that tools will not display all {@link BeanDefinition BeanDefinitions} for a given diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java index c1e764b22a5f..fcb2ef67e36a 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java @@ -1510,7 +1510,7 @@ protected void autowireByType( try { PropertyDescriptor pd = bw.getPropertyDescriptor(propertyName); // Don't try autowiring by type for type Object: never makes sense, - // even if it technically is a unsatisfied, non-simple property. + // even if it technically is an unsatisfied, non-simple property. if (Object.class != pd.getPropertyType()) { MethodParameter methodParam = BeanUtils.getWriteMethodParameter(pd); // Do not allow eager init for type matching in case of a prioritized post-processor. diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java index 2ceff658dbce..d100adad4423 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanDefinition.java @@ -945,7 +945,7 @@ public String getInitMethodName() { } /** - * Specify whether or not the configured initializer method is the default. + * Specify whether the configured initializer method is the default. *

The default value is {@code true} for a locally specified init method * but switched to {@code false} for a shared setting in a defaults section * (e.g. {@code bean init-method} versus {@code beans default-init-method} @@ -984,7 +984,7 @@ public String getDestroyMethodName() { } /** - * Specify whether or not the configured destroy method is the default. + * Specify whether the configured destroy method is the default. *

The default value is {@code true} for a locally specified destroy method * but switched to {@code false} for a shared setting in a defaults section * (e.g. {@code bean destroy-method} versus {@code beans default-destroy-method} diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java index e36cef415730..5d7b60055b60 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java @@ -593,7 +593,7 @@ else if (containsSingleton(beanName) && !containsBeanDefinition(beanName)) { RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName); BeanDefinitionHolder dbd = mbd.getDecoratedDefinition(); - // Setup the types that we want to match against + // Set up the types that we want to match against Class classToMatch = typeToMatch.resolve(); if (classToMatch == null) { classToMatch = FactoryBean.class; diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java index bd19259339e2..bb958ed499d6 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/BeanDefinitionBuilder.java @@ -293,7 +293,7 @@ public BeanDefinitionBuilder setScope(@Nullable String scope) { } /** - * Set whether or not this definition is abstract. + * Set whether this definition is abstract. */ public BeanDefinitionBuilder setAbstract(boolean flag) { this.beanDefinition.setAbstract(flag); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java index 5f3d5f62ac41..53084373a6b8 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/DefaultListableBeanFactory.java @@ -280,7 +280,7 @@ public void setDependencyComparator(@Nullable Comparator dependencyCompa } /** - * Return the dependency comparator for this BeanFactory (may be {@code null}. + * Return the dependency comparator for this BeanFactory (may be {@code null}). * @since 4.0 */ @Nullable diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java index 01b81450903d..fbcd955a6b4f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/support/GenericTypeAwareAutowireCandidateResolver.java @@ -33,7 +33,7 @@ /** * Basic {@link AutowireCandidateResolver} that performs a full generic type * match with the candidate's type if the dependency is declared as a generic type - * (e.g. Repository<Customer>). + * (e.g. {@code Repository}). * *

This is the base class for * {@link org.springframework.beans.factory.annotation.QualifierAnnotationAutowireCandidateResolver}, diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java index 288ad403f4b4..018c85123f9b 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/AbstractBeanDefinitionParser.java @@ -124,7 +124,7 @@ protected String resolveId(Element element, AbstractBeanDefinition definition, P /** * Register the supplied {@link BeanDefinitionHolder bean} with the supplied * {@link BeanDefinitionRegistry registry}. - *

Subclasses can override this method to control whether or not the supplied + *

Subclasses can override this method to control whether the supplied * {@link BeanDefinitionHolder bean} is actually even registered, or to * register even more beans. *

The default implementation registers the supplied {@link BeanDefinitionHolder bean} diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java index 6be311eb1efe..b25951082fa2 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/BeanDefinitionParserDelegate.java @@ -1362,7 +1362,7 @@ public boolean parseMergeAttribute(Element collectionElement) { } /** - * Parse a custom element (outside of the default namespace). + * Parse a custom element (outside the default namespace). * @param ele the element to parse * @return the resulting bean definition */ @@ -1372,7 +1372,7 @@ public BeanDefinition parseCustomElement(Element ele) { } /** - * Parse a custom element (outside of the default namespace). + * Parse a custom element (outside the default namespace). * @param ele the element to parse * @param containingBd the containing bean definition (if any) * @return the resulting bean definition diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java index 6dfda38e6bd4..815e0f59b5ff 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DefaultNamespaceHandlerResolver.java @@ -96,7 +96,7 @@ public DefaultNamespaceHandlerResolver(@Nullable ClassLoader classLoader) { * Create a new {@code DefaultNamespaceHandlerResolver} using the * supplied mapping file location. * @param classLoader the {@link ClassLoader} instance used to load mapping resources - * may be {@code null}, in which case the thread context ClassLoader will be used) + * may be {@code null}, in which case the thread context ClassLoader will be used * @param handlerMappingsLocation the mapping file location */ public DefaultNamespaceHandlerResolver(@Nullable ClassLoader classLoader, String handlerMappingsLocation) { diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java index 1335d0401787..fe8f6f61a37f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/DelegatingEntityResolver.java @@ -56,7 +56,7 @@ public class DelegatingEntityResolver implements EntityResolver { *

Configures the {@link PluggableSchemaResolver} with the supplied * {@link ClassLoader}. * @param classLoader the ClassLoader to use for loading - * (can be {@code null}) to use the default ClassLoader) + * (can be {@code null} to use the default ClassLoader) */ public DelegatingEntityResolver(@Nullable ClassLoader classLoader) { this.dtdResolver = new BeansDtdResolver(); diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java index 82d632302d52..659b21b40b97 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/PluggableSchemaResolver.java @@ -80,7 +80,7 @@ public class PluggableSchemaResolver implements EntityResolver { * Loads the schema URL → schema file location mappings using the default * mapping file pattern "META-INF/spring.schemas". * @param classLoader the ClassLoader to use for loading - * (can be {@code null}) to use the default ClassLoader) + * (can be {@code null} to use the default ClassLoader) * @see PropertiesLoaderUtils#loadAllProperties(String, ClassLoader) */ public PluggableSchemaResolver(@Nullable ClassLoader classLoader) { @@ -92,7 +92,7 @@ public PluggableSchemaResolver(@Nullable ClassLoader classLoader) { * Loads the schema URL → schema file location mappings using the given * mapping file pattern. * @param classLoader the ClassLoader to use for loading - * (can be {@code null}) to use the default ClassLoader) + * (can be {@code null} to use the default ClassLoader) * @param schemaMappingsLocation the location of the file that defines schema mappings * (must not be empty) * @see PropertiesLoaderUtils#loadAllProperties(String, ClassLoader) diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java index ddffb17d5175..1bc26a924c81 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/SimpleConstructorNamespaceHandler.java @@ -50,7 +50,7 @@ * the bean that will be considered as a parameter. * * Note: This implementation supports only named parameters - there is no - * support for indexes or types. Further more, the names are used as hints by + * support for indexes or types. Furthermore, the names are used as hints by * the container which, by default, does type introspection. * * @author Costin Leau diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java b/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java index 589208a4d3af..4c930c3820d8 100644 --- a/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java +++ b/spring-beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java @@ -184,7 +184,7 @@ public int getValidationMode() { } /** - * Set whether or not the XML parser should be XML namespace aware. + * Set whether the XML parser should be XML namespace aware. * Default is "false". *

This is typically not needed when schema validation is active. * However, without validation, this has to be switched to "true" @@ -195,7 +195,7 @@ public void setNamespaceAware(boolean namespaceAware) { } /** - * Return whether or not the XML parser should be XML namespace aware. + * Return whether the XML parser should be XML namespace aware. */ public boolean isNamespaceAware() { return this.namespaceAware; diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java index 1a7a8ccc24f8..e278c8721b65 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/StringArrayPropertyEditor.java @@ -26,7 +26,7 @@ * Custom {@link java.beans.PropertyEditor} for String arrays. * *

Strings must be in CSV format, with a customizable separator. - * By default values in the result are trimmed of whitespace. + * By default, values in the result are trimmed of whitespace. * * @author Rod Johnson * @author Juergen Hoeller @@ -86,7 +86,7 @@ public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull) { * @param emptyArrayAsNull {@code true} if an empty String array * is to be transformed into {@code null} * @param trimValues {@code true} if the values in the parsed arrays - * are to be trimmed of whitespace (default is true) + * are to be trimmed of whitespace (default is {@code true}) */ public StringArrayPropertyEditor(String separator, boolean emptyArrayAsNull, boolean trimValues) { this(separator, null, emptyArrayAsNull, trimValues); @@ -114,7 +114,7 @@ public StringArrayPropertyEditor(String separator, @Nullable String charsToDelet * @param emptyArrayAsNull {@code true} if an empty String array * is to be transformed into {@code null} * @param trimValues {@code true} if the values in the parsed arrays - * are to be trimmed of whitespace (default is true) + * are to be trimmed of whitespace (default is {@code true}) */ public StringArrayPropertyEditor( String separator, @Nullable String charsToDelete, boolean emptyArrayAsNull, boolean trimValues) { diff --git a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java index 344fb5d439f9..e94e65f5a94f 100644 --- a/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java +++ b/spring-beans/src/main/java/org/springframework/beans/propertyeditors/URIEditor.java @@ -130,7 +130,7 @@ public void setAsText(String text) throws IllegalArgumentException { /** * Create a URI instance for the given user-specified String value. - *

The default implementation encodes the value into a RFC-2396 compliant URI. + *

The default implementation encodes the value into an RFC-2396 compliant URI. * @param value the value to convert into a URI instance * @return the URI instance * @throws java.net.URISyntaxException if URI conversion failed diff --git a/spring-beans/src/test/java/org/springframework/beans/factory/config/MethodInvokingFactoryBeanTests.java b/spring-beans/src/test/java/org/springframework/beans/factory/config/MethodInvokingFactoryBeanTests.java index 810b24778330..afc921fa4fdb 100644 --- a/spring-beans/src/test/java/org/springframework/beans/factory/config/MethodInvokingFactoryBeanTests.java +++ b/spring-beans/src/test/java/org/springframework/beans/factory/config/MethodInvokingFactoryBeanTests.java @@ -43,7 +43,7 @@ public class MethodInvokingFactoryBeanTests { @Test public void testParameterValidation() throws Exception { - // assert that only static OR non static are set, but not both or none + // assert that only static OR non-static are set, but not both or none MethodInvokingFactoryBean mcfb = new MethodInvokingFactoryBean(); assertThatIllegalArgumentException().isThrownBy(mcfb::afterPropertiesSet); diff --git a/spring-beans/src/testFixtures/java/org/springframework/beans/testfixture/beans/ITestBean.java b/spring-beans/src/testFixtures/java/org/springframework/beans/testfixture/beans/ITestBean.java index 742b39c4ea7e..43ce2dd40ed8 100644 --- a/spring-beans/src/testFixtures/java/org/springframework/beans/testfixture/beans/ITestBean.java +++ b/spring-beans/src/testFixtures/java/org/springframework/beans/testfixture/beans/ITestBean.java @@ -22,7 +22,7 @@ * Interface used for {@link org.springframework.beans.testfixture.beans.TestBean}. * *

Two methods are the same as on Person, but if this - * extends person it breaks quite a few tests.. + * extends person it breaks quite a few tests. * * @author Rod Johnson * @author Juergen Hoeller