Skip to content

Commit 2a41de0

Browse files
committed
Polish Javadoc in Spring MVC async support
This commit fixes some typographical and grammatical errors in various classes in Spring MVC's async support.
1 parent 3cdb866 commit 2a41de0

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResult.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2012 the original author or authors.
2+
* Copyright 2002-2013 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -32,13 +32,13 @@
3232
* <p>Subclasses can extend this class to easily associate additional data or
3333
* behavior with the {@link DeferredResult}. For example, one might want to
3434
* associate the user used to create the {@link DeferredResult} by extending the
35-
* class and adding an addition property for the user. In this way, the user
35+
* class and adding an additional property for the user. In this way, the user
3636
* could easily be accessed later without the need to use a data structure to do
3737
* the mapping.
3838
*
3939
* <p>An example of associating additional behavior to this class might be
4040
* realized by extending the class to implement an additional interface. For
41-
* example, one might want to implement a {@link Comparable} so that when the
41+
* example, one might want to implement {@link Comparable} so that when the
4242
* {@link DeferredResult} is added to a {@link PriorityQueue} it is handled in
4343
* the correct order.
4444
*

spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2012 the original author or authors.
2+
* Copyright 2002-2013 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -37,9 +37,9 @@
3737
* as an SPI and not typically used directly by application classes.
3838
*
3939
* <p>An async scenario starts with request processing as usual in a thread (T1).
40-
* Concurrent request handling can be innitiated by calling
41-
* {@linkplain #startCallableProcessing(Callable, Object...) startCallableProcessing} or
42-
* {@linkplain #startDeferredResultProcessing(DeferredResult, Object...) startDeferredResultProcessing}
40+
* Concurrent request handling can be initiated by calling
41+
* {@link #startCallableProcessing(Callable, Object...) startCallableProcessing} or
42+
* {@link #startDeferredResultProcessing(DeferredResult, Object...) startDeferredResultProcessing},
4343
* both of which produce a result in a separate thread (T2). The result is saved
4444
* and the request dispatched to the container, to resume processing with the saved
4545
* result in a third thread (T3). Within the dispatched thread (T3), the saved
@@ -263,7 +263,7 @@ public void startCallableProcessing(final Callable<?> callable, Object... proces
263263
* the timeout value of the {@code AsyncWebRequest} before delegating to
264264
* {@link #startCallableProcessing(Callable, Object...)}.
265265
*
266-
* @param webAsyncTask an WebAsyncTask containing the target {@code Callable}
266+
* @param webAsyncTask a WebAsyncTask containing the target {@code Callable}
267267
* @param processingContext additional context to save that can be accessed
268268
* via {@link #getConcurrentResultContext()}
269269
* @throws Exception If concurrent processing failed to start

spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncTask.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2012 the original author or authors.
2+
* Copyright 2002-2013 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -46,15 +46,15 @@ public class WebAsyncTask<V> {
4646

4747

4848
/**
49-
* Create an {@code WebAsyncTask} wrapping the given {@link Callable}.
49+
* Create a {@code WebAsyncTask} wrapping the given {@link Callable}.
5050
* @param callable the callable for concurrent handling
5151
*/
5252
public WebAsyncTask(Callable<V> callable) {
5353
this(null, null, null, callable);
5454
}
5555

5656
/**
57-
* Create an {@code WebAsyncTask} with a timeout value and a {@link Callable}.
57+
* Create a {@code WebAsyncTask} with a timeout value and a {@link Callable}.
5858
* @param timeout timeout value in milliseconds
5959
* @param callable the callable for concurrent handling
6060
*/
@@ -63,7 +63,7 @@ public WebAsyncTask(long timeout, Callable<V> callable) {
6363
}
6464

6565
/**
66-
* Create an {@code WebAsyncTask} with a timeout value, an executor name, and a {@link Callable}.
66+
* Create a {@code WebAsyncTask} with a timeout value, an executor name, and a {@link Callable}.
6767
* @param timeout timeout value in milliseconds; ignored if {@code null}
6868
* @param callable the callable for concurrent handling
6969
*/
@@ -73,7 +73,7 @@ public WebAsyncTask(Long timeout, String executorName, Callable<V> callable) {
7373
}
7474

7575
/**
76-
* Create an {@code WebAsyncTask} with a timeout value, an executor instance, and a Callable.
76+
* Create a {@code WebAsyncTask} with a timeout value, an executor instance, and a Callable.
7777
* @param timeout timeout value in milliseconds; ignored if {@code null}
7878
* @param callable the callable for concurrent handling
7979
*/
@@ -113,7 +113,7 @@ public AsyncTaskExecutor getExecutor() {
113113
return this.executor;
114114
}
115115
else if (this.executorName != null) {
116-
Assert.state(this.beanFactory != null, "A BeanFactory is required to look up an task executor bean");
116+
Assert.state(this.beanFactory != null, "A BeanFactory is required to look up a task executor bean");
117117
return this.beanFactory.getBean(this.executorName, AsyncTaskExecutor.class);
118118
}
119119
else {

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/AsyncSupportConfigurer.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2012 the original author or authors.
2+
* Copyright 2002-2013 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -29,7 +29,7 @@
2929
import org.springframework.web.context.request.async.DeferredResultProcessingInterceptor;
3030

3131
/**
32-
* Helps with configuring a options for asynchronous request processing.
32+
* Helps with configuring options for asynchronous request processing.
3333
*
3434
* @author Rossen Stoyanchev
3535
* @since 3.2
@@ -50,9 +50,9 @@ public class AsyncSupportConfigurer {
5050
/**
5151
* Set the default {@link AsyncTaskExecutor} to use when a controller method
5252
* returns a {@link Callable}. Controller methods can override this default on
53-
* a per-request basis by returning an {@link WebAsyncTask}.
53+
* a per-request basis by returning a {@link WebAsyncTask}.
5454
*
55-
* <p>By default a {@link SimpleAsyncTaskExecutor} instance is used and it's
55+
* <p>By default a {@link SimpleAsyncTaskExecutor} instance is used, and it's
5656
* highly recommended to change that default in production since the simple
5757
* executor does not re-use threads.
5858
*
@@ -79,7 +79,7 @@ public AsyncSupportConfigurer setDefaultTimeout(long timeout) {
7979
}
8080

8181
/**
82-
* Configure lifecycle intercepters with callbacks around concurrent request
82+
* Configure lifecycle interceptors with callbacks around concurrent request
8383
* execution that starts when a controller returns a
8484
* {@link java.util.concurrent.Callable}.
8585
*
@@ -92,7 +92,7 @@ public AsyncSupportConfigurer registerCallableInterceptors(CallableProcessingInt
9292
}
9393

9494
/**
95-
* Configure lifecycle intercepters with callbacks around concurrent request
95+
* Configure lifecycle interceptors with callbacks around concurrent request
9696
* execution that starts when a controller returns a {@link DeferredResult}.
9797
*
9898
* @param interceptors the interceptors to register

0 commit comments

Comments
 (0)