Polishing

Author: jhoeller

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

@@ -26,34 +26,32 @@
 import org.springframework.web.context.request.NativeWebRequest;
 
 /**
- * {@code DeferredResult} provides an alternative to using a {@link Callable}
- * for asynchronous request processing. While a {@code Callable} is executed
- * concurrently on behalf of the application, with a {@code DeferredResult} the
- * application can produce the result from a thread of its choice.
+ * {@code DeferredResult} provides an alternative to using a {@link Callable} for
+ * asynchronous request processing. While a {@code Callable} is executed concurrently
+ * on behalf of the application, with a {@code DeferredResult} the application can
+ * produce the result from a thread of its choice.
  *
- * <p>Subclasses can extend this class to easily associate additional data or
- * behavior with the {@link DeferredResult}. For example, one might want to
- * associate the user used to create the {@link DeferredResult} by extending the
- * class and adding an additional property for the user. In this way, the user
- * could easily be accessed later without the need to use a data structure to do
- * the mapping.
+ * <p>Subclasses can extend this class to easily associate additional data or behavior
+ * with the {@link DeferredResult}. For example, one might want to associate the user
+ * used to create the {@link DeferredResult} by extending the class and adding an
+ * additional property for the user. In this way, the user could easily be accessed
+ * later without the need to use a data structure to do the mapping.
  *
- * <p>An example of associating additional behavior to this class might be
- * realized by extending the class to implement an additional interface. For
- * example, one might want to implement {@link Comparable} so that when the
- * {@link DeferredResult} is added to a {@link PriorityQueue} it is handled in
- * the correct order.
+ * <p>An example of associating additional behavior to this class might be realized
+ * by extending the class to implement an additional interface. For example, one
+ * might want to implement {@link Comparable} so that when the {@link DeferredResult}
+ * is added to a {@link PriorityQueue} it is handled in the correct order.
  *
  * @author Rossen Stoyanchev
  * @author Rob Winch
  * @since 3.2
  */
 public class DeferredResult<T> {
 
-	private static final Log logger = LogFactory.getLog(DeferredResult.class);
-
 	private static final Object RESULT_NONE = new Object();
 
+	private static final Log logger = LogFactory.getLog(DeferredResult.class);
+
 
 	private final Long timeout;
 
@@ -88,7 +86,7 @@ public DeferredResult(long timeout) {
 	/**
 	 * Create a DeferredResult with a timeout value and a default result to use
 	 * in case of timeout.
-	 * @param timeout timeout value in milliseconds; ignored if {@code null}
+	 * @param timeout timeout value in milliseconds (ignored if {@code null})
 	 * @param timeoutResult the result to use
 	 */
 	public DeferredResult(Long timeout, Object timeoutResult) {
@@ -117,22 +115,21 @@ final Long getTimeoutValue() {
 	}
 
 	/**
-	 * Register code to invoke when the async request times out. This method is
-	 * called from a container thread when an async request times out before the
-	 * {@code DeferredResult} has been set. It may invoke
-	 * {@link DeferredResult#setResult(Object) setResult} or
-	 * {@link DeferredResult#setErrorResult(Object) setErrorResult} to resume
-	 * processing.
+	 * Register code to invoke when the async request times out.
+	 * <p>This method is called from a container thread when an async request
+	 * times out before the {@code DeferredResult} has been populated.
+	 * It may invoke {@link DeferredResult#setResult setResult} or
+	 * {@link DeferredResult#setErrorResult setErrorResult} to resume processing.
 	 */
 	public void onTimeout(Runnable callback) {
 		this.timeoutCallback = callback;
 	}
 
 	/**
-	 * Register code to invoke when the async request completes. This method is
-	 * called from a container thread when an async request completed for any
-	 * reason including timeout and network error. This method is useful for
-	 * detecting that a {@code DeferredResult} instance is no longer usable.
+	 * Register code to invoke when the async request completes.
+	 * <p>This method is called from a container thread when an async request
+	 * completed for any reason including timeout and network error. This is useful
+	 * for detecting that a {@code DeferredResult} instance is no longer usable.
 	 */
 	public void onCompletion(Runnable callback) {
 		this.completionCallback = callback;
@@ -161,8 +158,8 @@ public final void setResultHandler(DeferredResultHandler resultHandler) {
 	/**
 	 * Set the value for the DeferredResult and handle it.
 	 * @param result the value to set
-	 * @return "true" if the result was set and passed on for handling; "false"
-	 * if the result was already set or the async request expired.
+	 * @return "true" if the result was set and passed on for handling;
+	 * "false" if the result was already set or the async request expired
 	 * @see #isSetOrExpired()
 	 */
 	public boolean setResult(T result) {
@@ -183,13 +180,12 @@ private boolean setResultInternal(Object result) {
 	}
 
 	/**
-	 * Set an error value for the {@link DeferredResult} and handle it. The value
-	 * may be an {@link Exception} or {@link Throwable} in which case it will be
-	 * processed as if a handler raised the exception.
+	 * Set an error value for the {@link DeferredResult} and handle it.
+	 * The value may be an {@link Exception} or {@link Throwable} in which case
+	 * it will be processed as if a handler raised the exception.
 	 * @param result the error result value
 	 * @return "true" if the result was set to the error value and passed on for
-	 * handling; "false" if the result was already set or the async request
-	 * expired.
+	 * handling; "false" if the result was already set or the async request expired
 	 * @see #isSetOrExpired()
 	 */
 	public boolean setErrorResult(Object result) {