Remove duplicate words in documentation and polish Javadoc

This commit is contained in:
Sam Brannen
2020-03-31 11:49:15 +02:00
parent 53106d5741
commit e26764d249
94 changed files with 213 additions and 213 deletions

View File

@@ -33,9 +33,9 @@ public interface AfterReturningAdvice extends AfterAdvice {
/**
* Callback after a given method successfully returned.
* @param returnValue the value returned by the method, if any
* @param method method being invoked
* @param args arguments to the method
* @param target target of the method invocation. May be {@code null}.
* @param method the method being invoked
* @param args the arguments to the method
* @param target the target of the method invocation. May be {@code null}.
* @throws Throwable if this object wishes to abort the call.
* Any exception thrown will be returned to the caller if it's
* allowed by the method signature. Otherwise the exception

View File

@@ -32,9 +32,9 @@ public interface MethodBeforeAdvice extends BeforeAdvice {
/**
* Callback before a given method is invoked.
* @param method method being invoked
* @param args arguments to the method
* @param target target of the method invocation. May be {@code null}.
* @param method the method being invoked
* @param args the arguments to the method
* @param target the target of the method invocation. May be {@code null}.
* @throws Throwable if this object wishes to abort the call.
* Any exception thrown will be returned to the caller if it's
* allowed by the method signature. Otherwise the exception

View File

@@ -56,7 +56,7 @@ public class BeanFactoryAspectInstanceFactory implements MetadataAwareAspectInst
* introspect to create AJType metadata using the type returned for the
* given bean name from the BeanFactory.
* @param beanFactory the BeanFactory to obtain instance(s) from
* @param name name of the bean
* @param name the name of the bean
*/
public BeanFactoryAspectInstanceFactory(BeanFactory beanFactory, String name) {
this(beanFactory, name, null);

View File

@@ -189,7 +189,7 @@ public abstract class AbstractSingletonProxyFactoryBean extends ProxyConfig
/**
* Determine a TargetSource for the given target (or TargetSource).
* @param target target. If this is an implementation of TargetSource it is
* @param target the target. If this is an implementation of TargetSource it is
* used as our TargetSource; otherwise it is wrapped in a SingletonTargetSource.
* @return a TargetSource for this object
*/

View File

@@ -142,7 +142,7 @@ public interface Advised extends TargetClassAware {
/**
* Remove the advisor at the given index.
* @param index index of advisor to remove
* @param index the index of advisor to remove
* @throws AopConfigException if the index is invalid
*/
void removeAdvisor(int index) throws AopConfigException;
@@ -177,7 +177,7 @@ public interface Advised extends TargetClassAware {
* <p>Note that the given advice will apply to all invocations on the proxy,
* even to the {@code toString()} method! Use appropriate advice implementations
* or specify appropriate pointcuts to apply to a narrower set of methods.
* @param advice advice to add to the tail of the chain
* @param advice the advice to add to the tail of the chain
* @throws AopConfigException in case of invalid advice
* @see #addAdvice(int, Advice)
* @see org.springframework.aop.support.DefaultPointcutAdvisor
@@ -193,7 +193,7 @@ public interface Advised extends TargetClassAware {
* even to the {@code toString()} method! Use appropriate advice implementations
* or specify appropriate pointcuts to apply to a narrower set of methods.
* @param pos index from 0 (head)
* @param advice advice to add at the specified position in the advice chain
* @param advice the advice to add at the specified position in the advice chain
* @throws AopConfigException in case of invalid advice
*/
void addAdvice(int pos, Advice advice) throws AopConfigException;

View File

@@ -78,7 +78,7 @@ public abstract class AbstractExpressionPointcut implements ExpressionPointcut,
* Called when a new pointcut expression is set.
* The expression should be parsed at this point if possible.
* <p>This implementation is empty.
* @param expression expression to set
* @param expression the expression to set
* @throws IllegalArgumentException if the expression is invalid
* @see #setExpression
*/

View File

@@ -66,7 +66,7 @@ public class NameMatchMethodPointcut extends StaticMethodMatcherPointcut impleme
* before a proxy is used.
* <p><b>NB:</b> This method does not work after the proxy is in
* use, as advice chains will be cached.
* @param name name of the additional method that will match
* @param name the name of the additional method that will match
* @return this pointcut to allow for multiple additions in one line
*/
public NameMatchMethodPointcut addMethodName(String name) {

View File

@@ -76,7 +76,7 @@ public class NameMatchMethodPointcutAdvisor extends AbstractGenericPointcutAdvis
* Add another eligible method name, in addition to those already named.
* Like the set methods, this method is for use when configuring proxies,
* before a proxy is used.
* @param name name of the additional method that will match
* @param name the name of the additional method that will match
* @return this pointcut to allow for multiple additions in one line
* @see NameMatchMethodPointcut#addMethodName
*/

View File

@@ -115,7 +115,7 @@ public abstract class AbstractNestablePropertyAccessor extends AbstractPropertyA
/**
* Create a new accessor for the given object.
* @param object object wrapped by this accessor
* @param object the object wrapped by this accessor
*/
protected AbstractNestablePropertyAccessor(Object object) {
registerDefaultEditors();
@@ -134,7 +134,7 @@ public abstract class AbstractNestablePropertyAccessor extends AbstractPropertyA
/**
* Create a new accessor for the given object,
* registering a nested path that the object is in.
* @param object object wrapped by this accessor
* @param object the object wrapped by this accessor
* @param nestedPath the nested path of the object
* @param rootObject the root object at the top of the path
*/
@@ -146,7 +146,7 @@ public abstract class AbstractNestablePropertyAccessor extends AbstractPropertyA
/**
* Create a new accessor for the given object,
* registering a nested path that the object is in.
* @param object object wrapped by this accessor
* @param object the object wrapped by this accessor
* @param nestedPath the nested path of the object
* @param parent the containing accessor (must not be {@code null})
*/
@@ -737,7 +737,7 @@ public abstract class AbstractNestablePropertyAccessor extends AbstractPropertyA
/**
* Create a new nested property accessor instance.
* Can be overridden in subclasses to create a PropertyAccessor subclass.
* @param object object wrapped by this PropertyAccessor
* @param object the object wrapped by this PropertyAccessor
* @param nestedPath the nested path of the object
* @return the nested PropertyAccessor instance
*/

View File

@@ -97,7 +97,7 @@ public class BeanWrapperImpl extends AbstractNestablePropertyAccessor implements
/**
* Create a new BeanWrapperImpl for the given object.
* @param object object wrapped by this BeanWrapper
* @param object the object wrapped by this BeanWrapper
*/
public BeanWrapperImpl(Object object) {
super(object);
@@ -114,7 +114,7 @@ public class BeanWrapperImpl extends AbstractNestablePropertyAccessor implements
/**
* Create a new BeanWrapperImpl for the given object,
* registering a nested path that the object is in.
* @param object object wrapped by this BeanWrapper
* @param object the object wrapped by this BeanWrapper
* @param nestedPath the nested path of the object
* @param rootObject the root object at the top of the path
*/
@@ -125,7 +125,7 @@ public class BeanWrapperImpl extends AbstractNestablePropertyAccessor implements
/**
* Create a new BeanWrapperImpl for the given object,
* registering a nested path that the object is in.
* @param object object wrapped by this BeanWrapper
* @param object the object wrapped by this BeanWrapper
* @param nestedPath the nested path of the object
* @param parent the containing BeanWrapper (must not be {@code null})
*/

View File

@@ -52,7 +52,7 @@ public class DirectFieldAccessor extends AbstractNestablePropertyAccessor {
/**
* Create a new DirectFieldAccessor for the given object.
* @param object object wrapped by this DirectFieldAccessor
* @param object the object wrapped by this DirectFieldAccessor
*/
public DirectFieldAccessor(Object object) {
super(object);
@@ -61,7 +61,7 @@ public class DirectFieldAccessor extends AbstractNestablePropertyAccessor {
/**
* Create a new DirectFieldAccessor for the given object,
* registering a nested path that the object is in.
* @param object object wrapped by this DirectFieldAccessor
* @param object the object wrapped by this DirectFieldAccessor
* @param nestedPath the nested path of the object
* @param parent the containing DirectFieldAccessor (must not be {@code null})
*/

View File

@@ -78,7 +78,7 @@ public interface PropertyValues extends Iterable<PropertyValue> {
/**
* Return the changes since the previous PropertyValues.
* Subclasses should also override {@code equals}.
* @param old old property values
* @param old the old property values
* @return the updated or new properties.
* Return empty PropertyValues if there are no changes.
* @see Object#equals

View File

@@ -1771,7 +1771,7 @@ public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport imp
* Get the object for the given bean instance, either the bean
* instance itself or its created object in case of a FactoryBean.
* @param beanInstance the shared bean instance
* @param name name that may include factory dereference prefix
* @param name the name that may include factory dereference prefix
* @param beanName the canonical bean name
* @param mbd the merged bean definition
* @return the object to expose for the bean

View File

@@ -28,8 +28,8 @@ public class NoSuchMessageException extends RuntimeException {
/**
* Create a new exception.
* @param code code that could not be resolved for given locale
* @param locale locale that was used to search for the code within
* @param code the code that could not be resolved for given locale
* @param locale the locale that was used to search for the code within
*/
public NoSuchMessageException(String code, Locale locale) {
super("No message found under code '" + code + "' for locale '" + locale + "'.");
@@ -37,7 +37,7 @@ public class NoSuchMessageException extends RuntimeException {
/**
* Create a new exception.
* @param code code that could not be resolved for given locale
* @param code the code that could not be resolved for given locale
*/
public NoSuchMessageException(String code) {
super("No message found under code '" + code + "' for locale '" + Locale.getDefault() + "'.");

View File

@@ -44,7 +44,7 @@ public interface Condition {
/**
* Determine if the condition matches.
* @param context the condition context
* @param metadata metadata of the {@link org.springframework.core.type.AnnotationMetadata class}
* @param metadata the metadata of the {@link org.springframework.core.type.AnnotationMetadata class}
* or {@link org.springframework.core.type.MethodMetadata method} being checked
* @return {@code true} if the condition matches and the component can be registered,
* or {@code false} to veto the annotated component's registration

View File

@@ -149,7 +149,7 @@ public class FileSystemXmlApplicationContext extends AbstractXmlApplicationConte
* <p>Note: Even if a given path starts with a slash, it will get
* interpreted as relative to the current VM working directory.
* This is consistent with the semantics in a Servlet container.
* @param path path to the resource
* @param path the path to the resource
* @return the Resource handle
* @see org.springframework.web.context.support.XmlWebApplicationContext#getResourceByPath
*/

View File

@@ -79,7 +79,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the default Locale.
* @param code code of the message
* @param code the code of the message
* @param defaultMessage the String to return if the lookup fails
* @return the message
*/
@@ -90,7 +90,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the given Locale.
* @param code code of the message
* @param code the code of the message
* @param defaultMessage the String to return if the lookup fails
* @param locale the Locale in which to do lookup
* @return the message
@@ -102,7 +102,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the default Locale.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -114,7 +114,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the given Locale.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @param locale the Locale in which to do lookup
@@ -127,7 +127,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the default Locale.
* @param code code of the message
* @param code the code of the message
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/
@@ -137,7 +137,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the given Locale.
* @param code code of the message
* @param code the code of the message
* @param locale the Locale in which to do lookup
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -148,7 +148,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the default Locale.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -159,7 +159,7 @@ public class MessageSourceAccessor {
/**
* Retrieve the message for the given code and the given Locale.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param locale the Locale in which to do lookup
* @return the message

View File

@@ -137,7 +137,7 @@ public class StaticApplicationContext extends GenericApplicationContext {
/**
* Associate the given message with the given code.
* @param code lookup code
* @param locale locale message should be found within
* @param locale the locale message should be found within
* @param defaultMessage message associated with this lookup code
* @see #getStaticMessageSource
*/

View File

@@ -58,7 +58,7 @@ public class BindException extends Exception implements BindingResult {
/**
* Create a new BindException instance for a target bean.
* @param target target bean to bind onto
* @param target the target bean to bind onto
* @param objectName the name of the target object
* @see BeanPropertyBindingResult
*/

View File

@@ -916,7 +916,7 @@ public class ClassWriter extends ClassVisitor {
* if the constant pool already contains a similar item. <i>This method is intended for {@link
* Attribute} sub classes, and is normally not needed by class generators or adapters.</i>
*
* @param name name of the invoked method.
* @param name the name of the invoked method.
* @param descriptor field descriptor of the constant type.
* @param bootstrapMethodHandle the bootstrap method.
* @param bootstrapMethodArguments the bootstrap method constant arguments.
@@ -937,7 +937,7 @@ public class ClassWriter extends ClassVisitor {
* the constant pool already contains a similar item. <i>This method is intended for {@link
* Attribute} sub classes, and is normally not needed by class generators or adapters.</i>
*
* @param name name of the invoked method.
* @param name the name of the invoked method.
* @param descriptor descriptor of the invoke method.
* @param bootstrapMethodHandle the bootstrap method.
* @param bootstrapMethodArguments the bootstrap method constant arguments.

View File

@@ -36,7 +36,7 @@ interface AnnotationsProcessor<C, R> {
/**
* Called when an aggregate is about to be processed. This method may return
* a {@code non-null} result to short-circuit any further processing.
* @param context context information relevant to the processor
* @param context the context information relevant to the processor
* @param aggregateIndex the aggregate index about to be processed
* @return a {@code non-null} result if no further processing is required
*/
@@ -48,7 +48,7 @@ interface AnnotationsProcessor<C, R> {
/**
* Called when an array of annotations can be processed. This method may
* return a {@code non-null} result to short-circuit any further processing.
* @param context context information relevant to the processor
* @param context the context information relevant to the processor
* @param aggregateIndex the aggregate index of the provided annotations
* @param source the original source of the annotations, if known
* @param annotations the annotations to process (this array may contain

View File

@@ -455,7 +455,7 @@ public interface MergedAnnotation<A extends Annotation> {
* merged annotation.
* <p>The {@link Adapt adaptations} may be used to change the way that values
* are added.
* @param adaptations adaptations that should be applied to the annotation values
* @param adaptations the adaptations that should be applied to the annotation values
* @return an immutable map containing the attributes and values
*/
AnnotationAttributes asAnnotationAttributes(Adapt... adaptations);
@@ -463,7 +463,7 @@ public interface MergedAnnotation<A extends Annotation> {
/**
* Get an immutable {@link Map} that contains all the annotation attributes.
* <p>The {@link Adapt adaptations} may be used to change the way that values are added.
* @param adaptations adaptations that should be applied to the annotation values
* @param adaptations the adaptations that should be applied to the annotation values
* @return an immutable map containing the attributes and values
*/
Map<String, Object> asMap(Adapt... adaptations);
@@ -473,7 +473,7 @@ public interface MergedAnnotation<A extends Annotation> {
* attributes.
* <p>The {@link Adapt adaptations} may be used to change the way that values are added.
* @param factory a map factory
* @param adaptations adaptations that should be applied to the annotation values
* @param adaptations the adaptations that should be applied to the annotation values
* @return a map containing the attributes and values
*/
<T extends Map<String, Object>> T asMap(Function<MergedAnnotation<?>, T> factory, Adapt... adaptations);

View File

@@ -99,7 +99,7 @@ public abstract class MergedAnnotationCollectors {
* added} from each merged annotation
* {@link MergedAnnotation#asMap(Adapt...) as a map}.
* @param <A> the annotation type
* @param adaptations adaptations that should be applied to the annotation values
* @param adaptations the adaptations that should be applied to the annotation values
* @return a {@link Collector} which collects and synthesizes the
* annotations into a {@link LinkedMultiValueMap}
* @see #toMultiValueMap(Function, MergedAnnotation.Adapt...)
@@ -116,7 +116,7 @@ public abstract class MergedAnnotationCollectors {
* added} from each merged annotation
* {@link MergedAnnotation#asMap(Adapt...) as a map}.
* @param <A> the annotation type
* @param adaptations adaptations that should be applied to the annotation values
* @param adaptations the adaptations that should be applied to the annotation values
* @param finisher the finisher function for the new {@link MultiValueMap}
* @return a {@link Collector} which collects and synthesizes the
* annotations into a {@link LinkedMultiValueMap}

View File

@@ -213,12 +213,12 @@ public final class StringDecoder extends AbstractDataBufferDecoder<String> {
/**
* Create a {@code StringDecoder} for {@code "text/plain"}.
* @param ignored ignored
* @param stripDelimiter this flag is ignored
* @deprecated as of Spring 5.0.4, in favor of {@link #textPlainOnly()} or
* {@link #textPlainOnly(List, boolean)}
*/
@Deprecated
public static StringDecoder textPlainOnly(boolean ignored) {
public static StringDecoder textPlainOnly(boolean stripDelimiter) {
return textPlainOnly();
}
@@ -241,12 +241,12 @@ public final class StringDecoder extends AbstractDataBufferDecoder<String> {
/**
* Create a {@code StringDecoder} that supports all MIME types.
* @param ignored ignored
* @param stripDelimiter this flag is ignored
* @deprecated as of Spring 5.0.4, in favor of {@link #allMimeTypes()} or
* {@link #allMimeTypes(List, boolean)}
*/
@Deprecated
public static StringDecoder allMimeTypes(boolean ignored) {
public static StringDecoder allMimeTypes(boolean stripDelimiter) {
return allMimeTypes();
}

View File

@@ -315,7 +315,7 @@ public abstract class DataBufferUtils {
* {@code Flux} is subscribed to.
* @param source the stream of data buffers to be written
* @param channel the channel to write to
* @param position file position write write is to begin; must be non-negative
* @param position the file position where writing is to begin; must be non-negative
* @return a flux containing the same buffers as in {@code source}, that
* starts the writing process when subscribed to, and that publishes any
* writing errors and the completion signal
@@ -346,7 +346,7 @@ public abstract class DataBufferUtils {
* {@link StandardOpenOption#WRITE WRITE}).
* @param source the stream of data buffers to be written
* @param destination the path to the file
* @param options options specifying how the file is opened
* @param options the options specifying how the file is opened
* @return a {@link Mono} that indicates completion or error
* @since 5.2
*/

View File

@@ -59,7 +59,7 @@ public interface ToStringStyler {
/**
* Style the field separator.
* @param buffer buffer to print to
* @param buffer the buffer to print to
*/
void styleFieldSeparator(StringBuilder buffer);

View File

@@ -65,11 +65,11 @@ public abstract class FileSystemUtils {
}
/**
* Delete the supplied {@link File} - for directories,
* Delete the supplied {@link File} &mdash; for directories,
* recursively delete any nested directories or files as well.
* @param root the root {@code File} to delete
* @return {@code true} if the {@code File} existed and was deleted,
* or {@code false} it it did not exist
* or {@code false} if it did not exist
* @throws IOException in the case of I/O errors
* @since 5.0
*/

View File

@@ -86,8 +86,8 @@ public interface EvaluationContext {
/**
* Set a named variable within this evaluation context to a specified value.
* @param name variable to set
* @param value value to be placed in the variable
* @param name the name of the variable to set
* @param value the value to be placed in the variable
*/
void setVariable(String name, @Nullable Object value);

View File

@@ -190,8 +190,8 @@ public final class SpelCompiler implements Opcodes {
* because they anchor compiled classes in memory and prevent GC. If you have expressions
* continually recompiling over time then by replacing the classloader periodically
* at least some of the older variants can be garbage collected.
* @param name name of the class
* @param bytes bytecode for the class
* @param name the name of the class
* @param bytes the bytecode for the class
* @return the Class object for the compiled expression
*/
@SuppressWarnings("unchecked")

View File

@@ -41,7 +41,7 @@ public class ResultSetSupportingSqlParameter extends SqlParameter {
/**
* Create a new ResultSetSupportingSqlParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
*/
public ResultSetSupportingSqlParameter(String name, int sqlType) {
@@ -50,7 +50,7 @@ public class ResultSetSupportingSqlParameter extends SqlParameter {
/**
* Create a new ResultSetSupportingSqlParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param scale the number of digits after the decimal point
* (for DECIMAL and NUMERIC types)
@@ -61,7 +61,7 @@ public class ResultSetSupportingSqlParameter extends SqlParameter {
/**
* Create a new ResultSetSupportingSqlParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param typeName the type name of the parameter (optional)
*/
@@ -71,7 +71,7 @@ public class ResultSetSupportingSqlParameter extends SqlParameter {
/**
* Create a new ResultSetSupportingSqlParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rse the {@link ResultSetExtractor} to use for parsing the {@link ResultSet}
*/
@@ -82,7 +82,7 @@ public class ResultSetSupportingSqlParameter extends SqlParameter {
/**
* Create a new ResultSetSupportingSqlParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rch the {@link RowCallbackHandler} to use for parsing the {@link ResultSet}
*/
@@ -93,7 +93,7 @@ public class ResultSetSupportingSqlParameter extends SqlParameter {
/**
* Create a new ResultSetSupportingSqlParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rm the {@link RowMapper} to use for parsing the {@link ResultSet}
*/

View File

@@ -33,7 +33,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
*/
public SqlInOutParameter(String name, int sqlType) {
@@ -42,7 +42,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param scale the number of digits after the decimal point
* (for DECIMAL and NUMERIC types)
@@ -53,7 +53,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param typeName the type name of the parameter (optional)
*/
@@ -63,7 +63,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param typeName the type name of the parameter (optional)
* @param sqlReturnType custom value handler for complex type (optional)
@@ -74,7 +74,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rse the {@link ResultSetExtractor} to use for parsing the {@link ResultSet}
*/
@@ -84,7 +84,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rch the {@link RowCallbackHandler} to use for parsing the {@link ResultSet}
*/
@@ -94,7 +94,7 @@ public class SqlInOutParameter extends SqlOutParameter {
/**
* Create a new SqlInOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rm the {@link RowMapper} to use for parsing the {@link ResultSet}
*/

View File

@@ -40,7 +40,7 @@ public class SqlOutParameter extends ResultSetSupportingSqlParameter {
/**
* Create a new SqlOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
*/
public SqlOutParameter(String name, int sqlType) {
@@ -49,7 +49,7 @@ public class SqlOutParameter extends ResultSetSupportingSqlParameter {
/**
* Create a new SqlOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param scale the number of digits after the decimal point
* (for DECIMAL and NUMERIC types)
@@ -60,7 +60,7 @@ public class SqlOutParameter extends ResultSetSupportingSqlParameter {
/**
* Create a new SqlOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param typeName the type name of the parameter (optional)
*/
@@ -70,7 +70,7 @@ public class SqlOutParameter extends ResultSetSupportingSqlParameter {
/**
* Create a new SqlOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param typeName the type name of the parameter (optional)
* @param sqlReturnType custom value handler for complex type (optional)
@@ -82,7 +82,7 @@ public class SqlOutParameter extends ResultSetSupportingSqlParameter {
/**
* Create a new SqlOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rse the {@link ResultSetExtractor} to use for parsing the {@link ResultSet}
*/
@@ -92,7 +92,7 @@ public class SqlOutParameter extends ResultSetSupportingSqlParameter {
/**
* Create a new SqlOutParameter.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the parameter SQL type according to {@code java.sql.Types}
* @param rch the {@link RowCallbackHandler} to use for parsing the {@link ResultSet}
*/

View File

@@ -83,7 +83,7 @@ public class SqlParameter {
/**
* Create a new SqlParameter, supplying name and SQL type.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the SQL type of the parameter according to {@code java.sql.Types}
*/
public SqlParameter(String name, int sqlType) {
@@ -93,7 +93,7 @@ public class SqlParameter {
/**
* Create a new SqlParameter, supplying name and SQL type.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the SQL type of the parameter according to {@code java.sql.Types}
* @param typeName the type name of the parameter (optional)
*/
@@ -105,7 +105,7 @@ public class SqlParameter {
/**
* Create a new SqlParameter, supplying name and SQL type.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param sqlType the SQL type of the parameter according to {@code java.sql.Types}
* @param scale the number of digits after the decimal point
* (for DECIMAL and NUMERIC types)

View File

@@ -32,7 +32,7 @@ public class SqlReturnResultSet extends ResultSetSupportingSqlParameter {
/**
* Create a new instance of the {@link SqlReturnResultSet} class.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param extractor the {@link ResultSetExtractor} to use for parsing the {@link java.sql.ResultSet}
*/
public SqlReturnResultSet(String name, ResultSetExtractor<?> extractor) {
@@ -41,7 +41,7 @@ public class SqlReturnResultSet extends ResultSetSupportingSqlParameter {
/**
* Create a new instance of the {@link SqlReturnResultSet} class.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param handler the {@link RowCallbackHandler} to use for parsing the {@link java.sql.ResultSet}
*/
public SqlReturnResultSet(String name, RowCallbackHandler handler) {
@@ -50,7 +50,7 @@ public class SqlReturnResultSet extends ResultSetSupportingSqlParameter {
/**
* Create a new instance of the {@link SqlReturnResultSet} class.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
* @param mapper the {@link RowMapper} to use for parsing the {@link java.sql.ResultSet}
*/
public SqlReturnResultSet(String name, RowMapper<?> mapper) {

View File

@@ -30,7 +30,7 @@ public class SqlReturnUpdateCount extends SqlParameter {
/**
* Create a new SqlReturnUpdateCount.
* @param name name of the parameter, as used in input and output maps
* @param name the name of the parameter, as used in input and output maps
*/
public SqlReturnUpdateCount(String name) {
super(name, Types.INTEGER);

View File

@@ -110,7 +110,7 @@ public interface CallMetaDataProvider {
SqlParameter createDefaultOutParameter(String parameterName, CallParameterMetaData meta);
/**
* Create a default inout parameter based on the provided meta-data.
* Create a default in/out parameter based on the provided meta-data.
* This is used when no explicit parameter declaration has been made.
* @param parameterName the name of the parameter
* @param meta meta-data used for this call

View File

@@ -195,7 +195,7 @@ public class DataSourceTransactionManager extends AbstractPlatformTransactionMan
* through an explicit statement on the transactional connection:
* "SET TRANSACTION READ ONLY" as understood by Oracle, MySQL and Postgres.
* <p>The exact treatment, including any SQL statement executed on the connection,
* can be customized through through {@link #prepareTransactionalConnection}.
* can be customized through {@link #prepareTransactionalConnection}.
* <p>This mode of read-only handling goes beyond the {@link Connection#setReadOnly}
* hint that Spring applies by default. In contrast to that standard JDBC hint,
* "SET TRANSACTION READ ONLY" enforces an isolation-level-like connection mode

View File

@@ -387,7 +387,7 @@ public abstract class RdbmsOperation implements InitializingBean {
* Validate the parameters passed to an execute method based on declared parameters.
* Subclasses should invoke this method before every {@code executeQuery()}
* or {@code update()} method.
* @param parameters parameters supplied (may be {@code null})
* @param parameters the parameters supplied (may be {@code null})
* @throws InvalidDataAccessApiUsageException if the parameters are invalid
*/
protected void validateParameters(@Nullable Object[] parameters) throws InvalidDataAccessApiUsageException {

View File

@@ -102,7 +102,7 @@ public abstract class SqlQuery<T> extends SqlOperation {
* @param params parameters, similar to JDO query parameters.
* Primitive parameters must be represented by their Object wrapper type.
* The ordering of parameters is significant.
* @param context contextual information passed to the {@code mapRow}
* @param context the contextual information passed to the {@code mapRow}
* callback method. The JDBC operation itself doesn't rely on this parameter,
* but it can be useful for creating the objects of the result list.
* @return a List of objects, one per row of the ResultSet. Normally all these
@@ -215,7 +215,7 @@ public abstract class SqlQuery<T> extends SqlOperation {
* the SqlParameters. Primitive parameters must be represented by their Object wrapper
* type. The ordering of parameters is not significant since they are supplied in a
* SqlParameterMap which is an implementation of the Map interface.
* @param context contextual information passed to the {@code mapRow}
* @param context the contextual information passed to the {@code mapRow}
* callback method. The JDBC operation itself doesn't rely on this parameter,
* but it can be useful for creating the objects of the result list.
* @return a List of objects, one per row of the ResultSet. Normally all these
@@ -337,7 +337,7 @@ public abstract class SqlQuery<T> extends SqlOperation {
* @param paramMap a Map of parameter name to parameter object,
* matching named parameters specified in the SQL statement.
* Ordering is not significant.
* @param context contextual information passed to the {@code mapRow}
* @param context the contextual information passed to the {@code mapRow}
* callback method. The JDBC operation itself doesn't rely on this parameter,
* but it can be useful for creating the objects of the result list.
* @return a List of objects, one per row of the ResultSet. Normally all these
@@ -367,7 +367,7 @@ public abstract class SqlQuery<T> extends SqlOperation {
* @param parameters the parameters to the {@code execute()} method,
* in case subclass is interested; may be {@code null} if there
* were no parameters.
* @param context contextual information passed to the {@code mapRow}
* @param context the contextual information passed to the {@code mapRow}
* callback method. The JDBC operation itself doesn't rely on this parameter,
* but it can be useful for creating the objects of the result list.
* @see #execute

View File

@@ -50,7 +50,7 @@ public abstract class StoredProcedure extends SqlCall {
* Create a new object wrapper for a stored procedure.
* @param ds the DataSource to use throughout the lifetime
* of this object to obtain connections
* @param name name of the stored procedure in the database
* @param name the name of the stored procedure in the database
*/
protected StoredProcedure(DataSource ds, String name) {
setDataSource(ds);
@@ -60,7 +60,7 @@ public abstract class StoredProcedure extends SqlCall {
/**
* Create a new object wrapper for a stored procedure.
* @param jdbcTemplate the JdbcTemplate which wraps DataSource
* @param name name of the stored procedure in the database
* @param name the name of the stored procedure in the database
*/
protected StoredProcedure(JdbcTemplate jdbcTemplate, String name) {
setJdbcTemplate(jdbcTemplate);
@@ -78,15 +78,15 @@ public abstract class StoredProcedure extends SqlCall {
}
/**
* Declare a parameter. Overridden method.
* Parameters declared as {@code SqlParameter} and {@code SqlInOutParameter}
* will always be used to provide input values. In addition to this any parameter declared
* as {@code SqlOutParameter} where an non-null input value is provided will also be used
* as an input paraneter.
* Declare a parameter.
* <p>Parameters declared as {@code SqlParameter} and {@code SqlInOutParameter}
* will always be used to provide input values. In addition to this, any parameter declared
* as {@code SqlOutParameter} where a non-null input value is provided will also be used
* as an input parameter.
* <b>Note: Calls to declareParameter must be made in the same order as
* they appear in the database's stored procedure parameter list.</b>
* Names are purely used to help mapping.
* @param param parameter object
* <p>Names are purely used to help mapping.
* @param param the parameter object
*/
@Override
public void declareParameter(SqlParameter param) throws InvalidDataAccessApiUsageException {

View File

@@ -66,7 +66,7 @@ public interface JmsMessageOperations extends MessageSendingOperations<Destinati
* the given destination.
* @param destinationName the name of the target destination
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
*/
void convertAndSend(String destinationName, Object payload, Map<String, Object> headers)
throws MessagingException;
@@ -90,7 +90,7 @@ public interface JmsMessageOperations extends MessageSendingOperations<Destinati
* and send the resulting message to the given destination.
* @param destinationName the name of the target destination
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
* @param postProcessor the post processor to apply to the message
*/
void convertAndSend(String destinationName, Object payload, @Nullable Map<String, Object> headers,
@@ -147,7 +147,7 @@ public interface JmsMessageOperations extends MessageSendingOperations<Destinati
* receive the reply and convert its body of the specified target class.
* @param destinationName the name of the target destination
* @param request payload for the request message to send
* @param headers headers for the request message to send
* @param headers the headers for the request message to send
* @param targetClass the target type to convert the payload of the reply to
* @return the payload of the reply message, possibly {@code null} if the message
* could not be received, for example due to a timeout

View File

@@ -123,7 +123,7 @@ public class MappingJackson2MessageConverter implements SmartMessageConverter, B
/**
* Specify the encoding to use when converting to and from text-based
* message body content. The default encoding will be "UTF-8".
* <p>When reading from a a text-based message, an encoding may have been
* <p>When reading from a text-based message, an encoding may have been
* suggested through a special JMS property which will then be preferred
* over the encoding set on this MessageConverter instance.
* @see #setEncodingPropertyName

View File

@@ -156,7 +156,7 @@ public abstract class AbstractMessageSendingTemplate<D> implements MessageSendin
* {@link MessageConverter}, wrap it as a message with the given
* headers and apply the given post processor.
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
* @param postProcessor the post processor to apply to the message
* @return the converted message
*/

View File

@@ -59,7 +59,7 @@ public interface DestinationResolvingMessageSendingOperations<D> extends Message
* destination.
* @param destinationName the destination name to resolve
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
*/
<T> void convertAndSend(String destinationName, T payload, @Nullable Map<String, Object> headers)
throws MessagingException;
@@ -85,7 +85,7 @@ public interface DestinationResolvingMessageSendingOperations<D> extends Message
* and send the resulting message to the resolved destination.
* @param destinationName the destination name to resolve
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
* @param postProcessor the post processor to apply to the message
*/
<T> void convertAndSend(String destinationName, T payload, @Nullable Map<String, Object> headers,

View File

@@ -86,7 +86,7 @@ public interface MessageRequestReplyOperations<D> {
* receive the reply and convert its body of the specified target class.
* @param destination the target destination
* @param request payload for the request message to send
* @param headers headers for the request message to send
* @param headers the headers for the request message to send
* @param targetClass the target type to convert the payload of the reply to
* @return the payload of the reply message, possibly {@code null} if the message
* could not be received, for example due to a timeout

View File

@@ -69,7 +69,7 @@ public interface MessageSendingOperations<D> {
* the given destination.
* @param destination the target destination
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
*/
void convertAndSend(D destination, Object payload, Map<String, Object> headers) throws MessagingException;
@@ -101,7 +101,7 @@ public interface MessageSendingOperations<D> {
* and send the resulting message to the given destination.
* @param destination the target destination
* @param payload the Object to use as payload
* @param headers headers for the message to send
* @param headers the headers for the message to send
* @param postProcessor the post processor to apply to the message
*/
void convertAndSend(D destination, Object payload, @Nullable Map<String, Object> headers,

View File

@@ -51,7 +51,7 @@ public interface CacheAwareContextLoaderDelegate {
* implementation in Spring overrides this method appropriately.
* @param mergedContextConfiguration the merged context configuration used
* to load the application context; never {@code null}
* @return {@code true} if the the application context has been loaded
* @return {@code true} if the application context has been loaded
* @since 5.2
* @see #loadContext
* @see #closeContext

View File

@@ -249,7 +249,7 @@ public abstract class MockRestRequestMatchers {
* using formatting specifiers as defined in
* {@link String#format(String, Object...)}.
* @param expression the XPath optionally parameterized with arguments
* @param namespaces namespaces referenced in the XPath expression
* @param namespaces the namespaces referenced in the XPath expression
* @param args arguments to parameterize the XPath expression with
*/
public static XpathRequestMatchers xpath(String expression, Map<String, String> namespaces, Object... args)

View File

@@ -82,7 +82,7 @@ public class FluxExchangeResult<T> extends ExchangeResult {
* .returnResult()
* .consumeWith(result -> assertThat(...);
* </pre>
* @param consumer consumer for {@code "this"} instance
* @param consumer the consumer for {@code "this"} instance
*/
public void consumeWith(Consumer<FluxExchangeResult<T>> consumer) {
assertWithDiagnostics(() -> consumer.accept(this));

View File

@@ -963,7 +963,7 @@ public interface WebTestClient {
* <p>The XPath expression can be a parameterized string using
* formatting specifiers as defined in {@link String#format}.
* @param expression the XPath expression
* @param namespaces namespaces to use
* @param namespaces the namespaces to use
* @param args arguments to parameterize the expression
* @since 5.1
*/

View File

@@ -246,7 +246,7 @@ public abstract class MockMvcResultMatchers {
* <p>The XPath expression can be a parameterized string using formatting
* specifiers as defined in {@link String#format(String, Object...)}.
* @param expression the XPath expression, optionally parameterized with arguments
* @param namespaces namespaces referenced in the XPath expression
* @param namespaces the namespaces referenced in the XPath expression
* @param args arguments to parameterize the XPath expression with
*/
public static XpathResultMatchers xpath(String expression, Map<String, String> namespaces, Object... args)

View File

@@ -914,7 +914,7 @@ public class JtaTransactionManager extends AbstractPlatformTransactionManager
* Apply the given transaction timeout. The default implementation will call
* {@code UserTransaction.setTransactionTimeout} for a non-default timeout value.
* @param txObject the JtaTransactionObject containing the UserTransaction
* @param timeout timeout value taken from transaction definition
* @param timeout the timeout value taken from transaction definition
* @throws SystemException if thrown by the JTA implementation
* @see #doJtaBegin
* @see JtaTransactionObject#getUserTransaction()

View File

@@ -735,7 +735,7 @@ public abstract class AbstractReactiveTransactionManager implements ReactiveTran
* <p>The default implementation returns {@code false}, assuming that
* participating in existing transactions is generally not supported.
* Subclasses are of course encouraged to provide such support.
* @param transaction transaction object returned by doGetTransaction
* @param transaction the transaction object returned by doGetTransaction
* @return if there is an existing transaction
* @throws TransactionException in case of system errors
* @see #doGetTransaction
@@ -756,7 +756,7 @@ public abstract class AbstractReactiveTransactionManager implements ReactiveTran
* active transaction: The implementation of this method has to detect this and
* start an appropriate nested transaction.
* @param synchronizationManager the synchronization manager bound to the new transaction
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @param definition a TransactionDefinition instance, describing propagation
* behavior, isolation level, read-only flag, timeout, and transaction name
* @throws TransactionException in case of creation or system errors
@@ -772,7 +772,7 @@ public abstract class AbstractReactiveTransactionManager implements ReactiveTran
* <p>The default implementation throws a TransactionSuspensionNotSupportedException,
* assuming that transaction suspension is generally not supported.
* @param synchronizationManager the synchronization manager bound to the current transaction
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @return an object that holds suspended resources
* (will be kept unexamined for passing it into doResume)
* @throws org.springframework.transaction.TransactionSuspensionNotSupportedException if suspending is not supported by the transaction manager implementation
@@ -792,7 +792,7 @@ public abstract class AbstractReactiveTransactionManager implements ReactiveTran
* <p>The default implementation throws a TransactionSuspensionNotSupportedException,
* assuming that transaction suspension is generally not supported.
* @param synchronizationManager the synchronization manager bound to the current transaction
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @param suspendedResources the object that holds suspended resources,
* as returned by doSuspend
* @throws org.springframework.transaction.TransactionSuspensionNotSupportedException if resuming is not supported by the transaction manager implementation
@@ -876,7 +876,7 @@ public abstract class AbstractReactiveTransactionManager implements ReactiveTran
* immediately, passing in "STATUS_UNKNOWN". This is the best we can do if there's no
* chance to determine the actual outcome of the outer transaction.
* @param synchronizationManager the synchronization manager bound to the current transaction
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @param synchronizations a List of TransactionSynchronization objects
* @throws TransactionException in case of system errors
* @see #invokeAfterCompletion(TransactionSynchronizationManager, List, int)
@@ -897,7 +897,7 @@ public abstract class AbstractReactiveTransactionManager implements ReactiveTran
* on any outcome. The default implementation does nothing.
* <p>Should not throw any exceptions but just issue warnings on errors.
* @param synchronizationManager the synchronization manager bound to the current transaction
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
*/
protected Mono<Void> doCleanupAfterCompletion(TransactionSynchronizationManager synchronizationManager,
Object transaction) {

View File

@@ -1051,7 +1051,7 @@ public abstract class AbstractPlatformTransactionManager implements PlatformTran
* <p>The default implementation returns {@code false}, assuming that
* participating in existing transactions is generally not supported.
* Subclasses are of course encouraged to provide such support.
* @param transaction transaction object returned by doGetTransaction
* @param transaction the transaction object returned by doGetTransaction
* @return if there is an existing transaction
* @throws TransactionException in case of system errors
* @see #doGetTransaction
@@ -1092,7 +1092,7 @@ public abstract class AbstractPlatformTransactionManager implements PlatformTran
* will be called to start a nested transaction when necessary. In such a context,
* there will be an active transaction: The implementation of this method has
* to detect this and start an appropriate nested transaction.
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @param definition a TransactionDefinition instance, describing propagation
* behavior, isolation level, read-only flag, timeout, and transaction name
* @throws TransactionException in case of creation or system errors
@@ -1107,7 +1107,7 @@ public abstract class AbstractPlatformTransactionManager implements PlatformTran
* Transaction synchronization will already have been suspended.
* <p>The default implementation throws a TransactionSuspensionNotSupportedException,
* assuming that transaction suspension is generally not supported.
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @return an object that holds suspended resources
* (will be kept unexamined for passing it into doResume)
* @throws org.springframework.transaction.TransactionSuspensionNotSupportedException
@@ -1125,7 +1125,7 @@ public abstract class AbstractPlatformTransactionManager implements PlatformTran
* Transaction synchronization will be resumed afterwards.
* <p>The default implementation throws a TransactionSuspensionNotSupportedException,
* assuming that transaction suspension is generally not supported.
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @param suspendedResources the object that holds suspended resources,
* as returned by doSuspend
* @throws org.springframework.transaction.TransactionSuspensionNotSupportedException
@@ -1229,7 +1229,7 @@ public abstract class AbstractPlatformTransactionManager implements PlatformTran
* <p>The default implementation simply invokes the {@code afterCompletion} methods
* immediately, passing in "STATUS_UNKNOWN". This is the best we can do if there's no
* chance to determine the actual outcome of the outer transaction.
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
* @param synchronizations a List of TransactionSynchronization objects
* @throws TransactionException in case of system errors
* @see #invokeAfterCompletion(java.util.List, int)
@@ -1249,7 +1249,7 @@ public abstract class AbstractPlatformTransactionManager implements PlatformTran
* <p>Called after {@code doCommit} and {@code doRollback} execution,
* on any outcome. The default implementation does nothing.
* <p>Should not throw any exceptions but just issue warnings on errors.
* @param transaction transaction object returned by {@code doGetTransaction}
* @param transaction the transaction object returned by {@code doGetTransaction}
*/
protected void doCleanupAfterCompletion(Object transaction) {
}

View File

@@ -371,7 +371,7 @@ public abstract class AbstractReactiveTransactionAspectTests {
* have been created, as there's no distinction between target and proxy.
* In the case of Spring's own AOP framework, a proxy must be created
* using a suitably configured transaction interceptor
* @param target target if there's a distinct target. If not (AspectJ),
* @param target the target if there's a distinct target. If not (AspectJ),
* return target.
* @return transactional advised object
*/

View File

@@ -559,7 +559,7 @@ public abstract class AbstractTransactionAspectTests {
* have been created, as there's no distinction between target and proxy.
* In the case of Spring's own AOP framework, a proxy must be created
* using a suitably configured transaction interceptor
* @param target target if there's a distinct target. If not (AspectJ),
* @param target the target if there's a distinct target. If not (AspectJ),
* return target.
* @return transactional advised object
*/

View File

@@ -136,8 +136,8 @@ public abstract class AbstractJackson2Decoder extends Jackson2CodecSupport imple
/**
* Process the input publisher into a flux. Default implementation returns
* {@link Flux#from(Publisher)}, but subclasses can choose to to customize
* this behaviour.
* {@link Flux#from(Publisher)}, but subclasses can choose to customize
* this behavior.
* @param input the {@code DataBuffer} input stream to process
* @param elementType the expected type of elements in the output stream
* @param mimeType the MIME type associated with the input stream (optional)

View File

@@ -67,8 +67,8 @@ abstract class BaseCodecConfigurer implements CodecConfigurer {
}
/**
* Sub-classes should override this to create deep copy of
* {@link BaseDefaultCodecs} which can can be client or server specific.
* Sub-classes should override this to create a deep copy of
* {@link BaseDefaultCodecs} which can be client or server specific.
* @since 5.1.12
*/
protected abstract BaseDefaultCodecs cloneDefaultCodecs();

View File

@@ -212,7 +212,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
* buffers apply to the underlying container.
* @param data the item to write
* @return whether the current data item was written and another one
* requested ({@code true}), or or otherwise if more writes are required.
* requested ({@code true}), or otherwise if more writes are required.
*/
protected abstract boolean write(T data) throws IOException;

View File

@@ -92,7 +92,7 @@ public class ServletRequestDataBinder extends WebDataBinder {
* <p>The type of the target property for a multipart file can be MultipartFile,
* byte[], or String. The latter two receive the contents of the uploaded file;
* all metadata like original file name, content type, etc are lost in those cases.
* @param request request with parameters to bind (can be multipart)
* @param request the request with parameters to bind (can be multipart)
* @see org.springframework.web.multipart.MultipartHttpServletRequest
* @see org.springframework.web.multipart.MultipartFile
* @see #bind(org.springframework.beans.PropertyValues)

View File

@@ -101,7 +101,7 @@ public class WebRequestDataBinder extends WebDataBinder {
* <p>The type of the target property for a multipart file can be Part, MultipartFile,
* byte[], or String. The latter two receive the contents of the uploaded file;
* all metadata like original file name, content type, etc are lost in those cases.
* @param request request with parameters to bind (can be multipart)
* @param request the request with parameters to bind (can be multipart)
* @see org.springframework.web.multipart.MultipartRequest
* @see org.springframework.web.multipart.MultipartFile
* @see javax.servlet.http.Part
@@ -126,7 +126,7 @@ public class WebRequestDataBinder extends WebDataBinder {
/**
* Check if the request is a multipart request (by checking its Content-Type header).
* @param request request with parameters to bind
* @param request the request with parameters to bind
*/
private boolean isMultipartRequest(WebRequest request) {
String contentType = request.getHeader("Content-Type");

View File

@@ -73,7 +73,7 @@ public class WebAsyncTask<V> implements BeanFactoryAware {
/**
* Create a {@code WebAsyncTask} with a timeout value, an executor name, and a {@link Callable}.
* @param timeout timeout value in milliseconds; ignored if {@code null}
* @param timeout the timeout value in milliseconds; ignored if {@code null}
* @param executorName the name of an executor bean to use
* @param callable the callable for concurrent handling
*/
@@ -86,7 +86,7 @@ public class WebAsyncTask<V> implements BeanFactoryAware {
/**
* Create a {@code WebAsyncTask} with a timeout value, an executor instance, and a Callable.
* @param timeout timeout value in milliseconds; ignored if {@code null}
* @param timeout the timeout value in milliseconds; ignored if {@code null}
* @param executor the executor to use
* @param callable the callable for concurrent handling
*/

View File

@@ -59,7 +59,7 @@ public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHa
/**
* Dedicated log category for disconnected client exceptions.
* <p>Servlet containers dn't expose a a client disconnected callback, see
* <p>Servlet containers don't expose a client disconnected callback; see
* <a href="https://github.com/eclipse-ee4j/servlet-api/issues/44">eclipse-ee4j/servlet-api#44</a>.
* <p>To avoid filling logs with unnecessary stack traces, we make an
* effort to identify such network failures on a per-server basis, and then

View File

@@ -22,7 +22,7 @@ import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebSession;
/**
* Main class for for access to the {@link WebSession} for an HTTP request.
* Main class for access to the {@link WebSession} for an HTTP request.
*
* @author Rossen Stoyanchev
* @since 5.0

View File

@@ -591,7 +591,7 @@ public abstract class WebUtils {
* either via a button (directly with name) or via an image (name + ".x" or
* name + ".y").
* @param request current HTTP request
* @param name name of the parameter
* @param name the name of the parameter
* @return if the parameter was sent
* @see #SUBMIT_IMAGE_SUFFIXES
*/

View File

@@ -42,7 +42,7 @@ public class PathPatternParser {
/**
* Whether a {@link PathPattern} produced by this parser should should
* Whether a {@link PathPattern} produced by this parser should
* automatically match request paths with a trailing slash.
*
* <p>If set to {@code true} a {@code PathPattern} without a trailing slash

View File

@@ -34,7 +34,7 @@ public interface HandlerAdapter {
/**
* Whether this {@code HandlerAdapter} supports the given {@code handler}.
* @param handler handler object to check
* @param handler the handler object to check
* @return whether or not the handler is supported
*/
boolean supports(Object handler);

View File

@@ -31,7 +31,7 @@ public interface HandlerResultHandler {
/**
* Whether this handler supports the given {@link HandlerResult}.
* @param result result object to check
* @param result the result object to check
* @return whether or not this object can use the given result
*/
boolean supports(HandlerResult result);

View File

@@ -281,7 +281,7 @@ public abstract class RequestPredicates {
* Return a {@code RequestPredicate} that tests the request's query parameter of the given name
* against the given predicate.
* @param name the name of the query parameter to test against
* @param predicate predicate to test against the query parameter value
* @param predicate the predicate to test against the query parameter value
* @return a predicate that matches the given predicate against the query parameter of the given name
* @see ServerRequest#queryParam(String)
*/

View File

@@ -345,8 +345,8 @@ public interface ServerResponse {
/**
* Build the response entity with no body.
* The response will be committed when the given {@code voidPublisher} completes.
* @param voidPublisher publisher publisher to indicate when the response should be committed
* <p>The response will be committed when the given {@code voidPublisher} completes.
* @param voidPublisher the publisher to indicate when the response should be committed
*/
Mono<ServerResponse> build(Publisher<Void> voidPublisher);

View File

@@ -75,7 +75,7 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* Set a Map with URL paths as keys and {@code VersionStrategy} as values.
* <p>Supports direct URL matches and Ant-style pattern matches. For syntax
* details, see the {@link AntPathMatcher} javadoc.
* @param map map with URLs as keys and version strategies as values
* @param map a map with URLs as keys and version strategies as values
*/
public void setStrategyMap(Map<String, VersionStrategy> map) {
this.versionStrategyMap.clear();

View File

@@ -79,7 +79,7 @@ public abstract class AbstractMessageReaderArgumentResolver extends HandlerMetho
/**
* Constructor with {@link HttpMessageReader}'s and a {@link Validator}.
* @param readers readers to convert from the request body
* @param readers the readers to convert from the request body
*/
protected AbstractMessageReaderArgumentResolver(List<HttpMessageReader<?>> readers) {
this(readers, ReactiveAdapterRegistry.getSharedInstance());

View File

@@ -50,7 +50,7 @@ public class ResponseBodyResultHandler extends AbstractMessageWriterResultHandle
/**
* Basic constructor with a default {@link ReactiveAdapterRegistry}.
* @param writers writers for serializing to the response body
* @param writers the writers for serializing to the response body
* @param resolver to determine the requested content type
*/
public ResponseBodyResultHandler(List<HttpMessageWriter<?>> writers, RequestedContentTypeResolver resolver) {
@@ -59,7 +59,7 @@ public class ResponseBodyResultHandler extends AbstractMessageWriterResultHandle
/**
* Constructor with an {@link ReactiveAdapterRegistry} instance.
* @param writers writers for serializing to the response body
* @param writers the writers for serializing to the response body
* @param resolver to determine the requested content type
* @param registry for adaptation to reactive types
*/

View File

@@ -56,7 +56,7 @@ public class ResponseEntityResultHandler extends AbstractMessageWriterResultHand
/**
* Basic constructor with a default {@link ReactiveAdapterRegistry}.
* @param writers writers for serializing to the response body
* @param writers the writers for serializing to the response body
* @param resolver to determine the requested content type
*/
public ResponseEntityResultHandler(List<HttpMessageWriter<?>> writers,
@@ -67,7 +67,7 @@ public class ResponseEntityResultHandler extends AbstractMessageWriterResultHand
/**
* Constructor with an {@link ReactiveAdapterRegistry} instance.
* @param writers writers for serializing to the response body
* @param writers the writers for serializing to the response body
* @param resolver to determine the requested content type
* @param registry for adaptation to reactive types
*/

View File

@@ -241,7 +241,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param defaultMessage the String to return if the lookup fails
* @return the message
*/
@@ -251,7 +251,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -262,7 +262,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message as a List, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -273,7 +273,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @param htmlEscape if the message should be HTML-escaped
@@ -289,7 +289,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/
@@ -299,7 +299,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -310,7 +310,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message as a List, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -321,7 +321,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param htmlEscape if the message should be HTML-escaped
* @return the message
@@ -357,7 +357,7 @@ public class RequestContext {
/**
* Retrieve the Errors instance for the given bind object, using the
* "defaultHtmlEscape" setting.
* @param name name of the bind object
* @param name the name of the bind object
* @return the Errors instance, or {@code null} if not found
*/
@Nullable
@@ -367,7 +367,7 @@ public class RequestContext {
/**
* Retrieve the Errors instance for the given bind object.
* @param name name of the bind object
* @param name the name of the bind object
* @param htmlEscape create an Errors instance with automatic HTML escaping?
* @return the Errors instance, or {@code null} if not found
*/

View File

@@ -467,7 +467,7 @@ class CoRouterFunctionDsl internal constructor (private val init: (CoRouterFunct
* Return a [RequestPredicate] that tests the request's query parameter of the given name
* against the given predicate.
* @param name the name of the query parameter to test against
* @param predicate predicate to test against the query parameter value
* @param predicate the predicate to test against the query parameter value
* @return a predicate that matches the given predicate against the query parameter of the given name
* @see ServerRequest#queryParam
*/

View File

@@ -465,7 +465,7 @@ class RouterFunctionDsl internal constructor (private val init: RouterFunctionDs
* Return a [RequestPredicate] that tests the request's query parameter of the given name
* against the given predicate.
* @param name the name of the query parameter to test against
* @param predicate predicate to test against the query parameter value
* @param predicate the predicate to test against the query parameter value
* @return a predicate that matches the given predicate against the query parameter of the given name
* @see ServerRequest#queryParam(String)
*/

View File

@@ -57,7 +57,7 @@ public interface HandlerAdapter {
* <p>{@code
* return (handler instanceof MyHandler);
* }
* @param handler handler object to check
* @param handler the handler object to check
* @return whether or not this object can use the given handler
*/
boolean supports(Object handler);
@@ -67,7 +67,7 @@ public interface HandlerAdapter {
* The workflow that is required may vary widely.
* @param request current HTTP request
* @param response current HTTP response
* @param handler handler to use. This object must have previously been passed
* @param handler the handler to use. This object must have previously been passed
* to the {@code supports} method of this interface, which must have
* returned {@code true}.
* @throws Exception in case of errors
@@ -81,7 +81,7 @@ public interface HandlerAdapter {
* Same contract as for HttpServlet's {@code getLastModified} method.
* Can simply return -1 if there's no support in the handler class.
* @param request current HTTP request
* @param handler handler to use
* @param handler the handler to use
* @return the lastModified value for the given handler
* @see javax.servlet.http.HttpServlet#getLastModified
* @see org.springframework.web.servlet.mvc.LastModified#getLastModified

View File

@@ -114,7 +114,7 @@ public interface HandlerInterceptor {
* <p>The default implementation is empty.
* @param request current HTTP request
* @param response current HTTP response
* @param handler handler (or {@link HandlerMethod}) that started asynchronous
* @param handler the handler (or {@link HandlerMethod}) that started asynchronous
* execution, for type and/or instance examination
* @param modelAndView the {@code ModelAndView} that the handler returned
* (can also be {@code null})
@@ -139,7 +139,7 @@ public interface HandlerInterceptor {
* <p>The default implementation is empty.
* @param request current HTTP request
* @param response current HTTP response
* @param handler handler (or {@link HandlerMethod}) that started asynchronous
* @param handler the handler (or {@link HandlerMethod}) that started asynchronous
* execution, for type and/or instance examination
* @param ex any exception thrown on handler execution, if any; this does not
* include exceptions that have been handled through an exception resolver

View File

@@ -51,15 +51,15 @@ public interface ThemeResolver {
/**
* Resolve the current theme name via the given request.
* Should return a default theme as fallback in any case.
* @param request request to be used for resolution
* @param request the request to be used for resolution
* @return the current theme name
*/
String resolveThemeName(HttpServletRequest request);
/**
* Set the current theme name to the given one.
* @param request request to be used for theme name modification
* @param response response to be used for theme name modification
* @param request the request to be used for theme name modification
* @param response the response to be used for theme name modification
* @param themeName the new theme name ({@code null} or empty to reset it)
* @throws UnsupportedOperationException if the ThemeResolver implementation
* does not support dynamic changing of the theme

View File

@@ -278,7 +278,7 @@ public abstract class RequestPredicates {
* Return a {@code RequestPredicate} that tests the request's parameter of the given name
* against the given predicate.
* @param name the name of the parameter to test against
* @param predicate predicate to test against the parameter value
* @param predicate the predicate to test against the parameter value
* @return a predicate that matches the given predicate against the parameter of the given name
* @see ServerRequest#param(String)
*/

View File

@@ -105,7 +105,7 @@ public class ResponseBodyEmitter {
* <p>By default not set in which case the default configured in the MVC
* Java Config or the MVC namespace is used, or if that's not set, then the
* timeout depends on the default of the underlying server.
* @param timeout timeout value in milliseconds
* @param timeout the timeout value in milliseconds
*/
public ResponseBodyEmitter(Long timeout) {
this.timeout = timeout;

View File

@@ -53,7 +53,7 @@ public class SseEmitter extends ResponseBodyEmitter {
* <p>By default not set in which case the default configured in the MVC
* Java Config or the MVC namespace is used, or if that's not set, then the
* timeout depends on the default of the underlying server.
* @param timeout timeout value in milliseconds
* @param timeout the timeout value in milliseconds
* @since 4.2.2
*/
public SseEmitter(Long timeout) {

View File

@@ -75,7 +75,7 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* Set a Map with URL paths as keys and {@code VersionStrategy} as values.
* <p>Supports direct URL matches and Ant-style pattern matches. For syntax
* details, see the {@link org.springframework.util.AntPathMatcher} javadoc.
* @param map map with URLs as keys and version strategies as values
* @param map a map with URLs as keys and version strategies as values
*/
public void setStrategyMap(Map<String, VersionStrategy> map) {
this.versionStrategyMap.clear();

View File

@@ -613,7 +613,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param defaultMessage the String to return if the lookup fails
* @return the message
*/
@@ -623,7 +623,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -634,7 +634,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message as a List, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -645,7 +645,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @param htmlEscape if the message should be HTML-escaped
@@ -661,7 +661,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/
@@ -671,7 +671,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -682,7 +682,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message as a List, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -693,7 +693,7 @@ public class RequestContext {
/**
* Retrieve the message for the given code.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param htmlEscape if the message should be HTML-escaped
* @return the message
@@ -730,7 +730,7 @@ public class RequestContext {
* Retrieve the theme message for the given code.
* <p>Note that theme messages are never HTML-escaped, as they typically denote
* theme-specific resource paths and not client-visible messages.
* @param code code of the message
* @param code the code of the message
* @param defaultMessage the String to return if the lookup fails
* @return the message
*/
@@ -743,7 +743,7 @@ public class RequestContext {
* Retrieve the theme message for the given code.
* <p>Note that theme messages are never HTML-escaped, as they typically denote
* theme-specific resource paths and not client-visible messages.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -757,7 +757,7 @@ public class RequestContext {
* Retrieve the theme message for the given code.
* <p>Note that theme messages are never HTML-escaped, as they typically denote
* theme-specific resource paths and not client-visible messages.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message as a List, or {@code null} if none
* @param defaultMessage the String to return if the lookup fails
* @return the message
@@ -772,7 +772,7 @@ public class RequestContext {
* Retrieve the theme message for the given code.
* <p>Note that theme messages are never HTML-escaped, as they typically denote
* theme-specific resource paths and not client-visible messages.
* @param code code of the message
* @param code the code of the message
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
*/
@@ -784,7 +784,7 @@ public class RequestContext {
* Retrieve the theme message for the given code.
* <p>Note that theme messages are never HTML-escaped, as they typically denote
* theme-specific resource paths and not client-visible messages.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -797,7 +797,7 @@ public class RequestContext {
* Retrieve the theme message for the given code.
* <p>Note that theme messages are never HTML-escaped, as they typically denote
* theme-specific resource paths and not client-visible messages.
* @param code code of the message
* @param code the code of the message
* @param args arguments for the message as a List, or {@code null} if none
* @return the message
* @throws org.springframework.context.NoSuchMessageException if not found
@@ -820,7 +820,7 @@ public class RequestContext {
/**
* Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.
* @param name name of the bind object
* @param name the name of the bind object
* @return the Errors instance, or {@code null} if not found
*/
@Nullable
@@ -830,7 +830,7 @@ public class RequestContext {
/**
* Retrieve the Errors instance for the given bind object.
* @param name name of the bind object
* @param name the name of the bind object
* @param htmlEscape create an Errors instance with automatic HTML escaping?
* @return the Errors instance, or {@code null} if not found
*/

View File

@@ -462,7 +462,7 @@ class RouterFunctionDsl internal constructor (private val init: (RouterFunctionD
* Return a [RequestPredicate] that tests the request's query parameter of the given name
* against the given predicate.
* @param name the name of the query parameter to test against
* @param predicate predicate to test against the query parameter value
* @param predicate the predicate to test against the query parameter value
* @return a predicate that matches the given predicate against the query parameter of the given name
* @see ServerRequest#queryParam
*/

View File

@@ -57,7 +57,7 @@ public abstract class AbstractWebSocketSession<T> implements NativeWebSocketSess
/**
* Create a new instance and associate the given attributes with it.
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
* session; the provided attributes are copied, the original map is not used.
*/
public AbstractWebSocketSession(@Nullable Map<String, Object> attributes) {

View File

@@ -74,7 +74,7 @@ public class JettyWebSocketSession extends AbstractWebSocketSession<Session> {
/**
* Create a new {@link JettyWebSocketSession} instance.
* @param attributes attributes from the HTTP handshake to associate with the WebSocket session
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket session
*/
public JettyWebSocketSession(Map<String, Object> attributes) {
this(attributes, null);
@@ -82,7 +82,7 @@ public class JettyWebSocketSession extends AbstractWebSocketSession<Session> {
/**
* Create a new {@link JettyWebSocketSession} instance associated with the given user.
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
* session; the provided attributes are copied, the original map is not used.
* @param user the user associated with the session; if {@code null} we'll fallback on the
* user available via {@link org.eclipse.jetty.websocket.api.Session#getUpgradeRequest()}

View File

@@ -77,7 +77,7 @@ public class StandardWebSocketSession extends AbstractWebSocketSession<Session>
/**
* Constructor for a standard WebSocket session.
* @param headers the headers of the handshake request
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
* session; the provided attributes are copied, the original map is not used.
* @param localAddress the address on which the request was received
* @param remoteAddress the address of the remote client
@@ -91,7 +91,7 @@ public class StandardWebSocketSession extends AbstractWebSocketSession<Session>
/**
* Constructor that associates a user with the WebSocket session.
* @param headers the headers of the handshake request
* @param attributes attributes from the HTTP handshake to associate with the WebSocket session
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket session
* @param localAddress the address on which the request was received
* @param remoteAddress the address of the remote client
* @param user the user associated with the session; if {@code null} we'll

View File

@@ -116,7 +116,7 @@ public abstract class AbstractWebSocketClient implements WebSocketClient {
* @param uri the target URI for the handshake (never {@code null})
* @param subProtocols requested sub-protocols, or an empty list
* @param extensions requested WebSocket extensions, or an empty list
* @param attributes attributes to associate with the WebSocketSession, i.e. via
* @param attributes the attributes to associate with the WebSocketSession, i.e. via
* {@link WebSocketSession#getAttributes()}; currently always an empty map.
* @return the established WebSocket session wrapped in a ListenableFuture.
*/

View File

@@ -41,7 +41,7 @@ public interface HandshakeHandler {
* @param wsHandler the handler to process WebSocket messages; see
* {@link PerConnectionWebSocketHandler} for providing a handler with
* per-connection lifecycle.
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
* session; the provided attributes are copied, the original map is not used.
* @return whether the handshake negotiation was successful or not. In either case the
* response status, headers, and body will have been updated to reflect the

View File

@@ -40,7 +40,7 @@ public interface HandshakeInterceptor {
* @param request the current request
* @param response the current response
* @param wsHandler the target WebSocket handler
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
* session; the provided attributes are copied, the original map is not used.
* @return whether to proceed with the handshake ({@code true}) or abort ({@code false})
*/

View File

@@ -59,7 +59,7 @@ public abstract class AbstractSockJsSession implements SockJsSession {
/**
* Log category to use on network IO exceptions after a client has gone away.
* <p>Servlet containers dn't expose a a client disconnected callback, see
* <p>Servlet containers don't expose a client disconnected callback; see
* <a href="https://github.com/eclipse-ee4j/servlet-api/issues/44">eclipse-ee4j/servlet-api#44</a>.
* Therefore network IO failures may occur simply because a client has gone away,
* and that can fill the logs with unnecessary stack traces.
@@ -122,7 +122,7 @@ public abstract class AbstractSockJsSession implements SockJsSession {
* @param id the session ID
* @param config the SockJS service configuration options
* @param handler the recipient of SockJS messages
* @param attributes attributes from the HTTP handshake to associate with the WebSocket
* @param attributes the attributes from the HTTP handshake to associate with the WebSocket
* session; the provided attributes are copied, the original map is not used.
*/
public AbstractSockJsSession(String id, SockJsServiceConfig config, WebSocketHandler handler,

View File

@@ -29,11 +29,11 @@ formatting UI field values. You can use these packages as simpler alternatives t
`PropertyEditorSupport` implementations. They are also discussed in this chapter.
Spring supports Java Bean Validation through setup infrastructure and an adaptor to
Spring's own `Validator` contract. Application can enable Bean Validation once globally,
Spring's own `Validator` contract. Applications can enable Bean Validation once globally,
as described in <<validation-beanvalidation>>, and use it exclusively for all validation
needs. In the web layer, they can further register controller-local local Spring
needs. In the web layer, applications can further register controller-local Spring
`Validator` instances per `DataBinder`, as described in <<validation-binder>>, which can
be useful for plugging in custom validation logic creating annotations.
be useful for plugging in custom validation logic.