Polishing

Author: jhoeller

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,8 +55,8 @@
  * and obviates the need (<b>in part</b>) for a developer to code a method that
  * simply checks that all required properties have actually been set.
  *
- * <p>Please note that an 'init' method may still need to implemented (and may
- * still be desirable), because all that this class does is enforce that a
+ * <p>Please note that an 'init' method may still need to be implemented (and may
+ * still be desirable), because all that this class does is enforcing that a
  * 'required' property has actually been configured with a value. It does
  * <b>not</b> check anything else... In particular, it does not check that a
  * configured value is not {@code null}.

spring-expression/src/main/java/org/springframework/expression/spel/standard/Tokenizer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -265,7 +265,7 @@ else if (isTwoCharToken(TokenKind.SAFE_NAVI)) {
 						raiseParseException(this.pos, SpelMessage.UNEXPECTED_ESCAPE_CHAR);
 						break;
 					default:
-						throw new IllegalStateException("Cannot handle (" + Integer.valueOf(ch) + ") '" + ch + "'");
+						throw new IllegalStateException("Cannot handle (" + (int) ch + ") '" + ch + "'");
 				}
 			}
 		}

spring-jdbc/src/main/java/org/springframework/jdbc/support/DatabaseStartupValidator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -72,15 +72,15 @@ public void setValidationQuery(String validationQuery) {
 
 	/**
 	 * Set the interval between validation runs (in seconds).
-	 * Default is 1.
+	 * Default is {@value #DEFAULT_INTERVAL}.
 	 */
 	public void setInterval(int interval) {
 		this.interval = interval;
 	}
 
 	/**
 	 * Set the timeout (in seconds) after which a fatal exception
-	 * will be thrown. Default is 60.
+	 * will be thrown. Default is {@value #DEFAULT_TIMEOUT}.
 	 */
 	public void setTimeout(int timeout) {
 		this.timeout = timeout;
@@ -94,11 +94,12 @@ public void setTimeout(int timeout) {
 	 */
 	@Override
 	public void afterPropertiesSet() {
-		if (this.dataSource == null) {
-			throw new IllegalArgumentException("dataSource is required");
+		DataSource dataSource = this.dataSource;
+		if (dataSource == null) {
+			throw new IllegalArgumentException("Property 'dataSource' is required");
 		}
 		if (this.validationQuery == null) {
-			throw new IllegalArgumentException("validationQuery is required");
+			throw new IllegalArgumentException("Property 'validationQuery' is required");
 		}
 
 		try {
@@ -111,18 +112,22 @@ public void afterPropertiesSet() {
 				Connection con = null;
 				Statement stmt = null;
 				try {
-					con = this.dataSource.getConnection();
+					con = dataSource.getConnection();
 					stmt = con.createStatement();
 					stmt.execute(this.validationQuery);
 					validated = true;
 				}
 				catch (SQLException ex) {
 					latestEx = ex;
-					logger.debug("Validation query [" + this.validationQuery + "] threw exception", ex);
-					float rest = ((float) (deadLine - System.currentTimeMillis())) / 1000;
-					if (rest > this.interval) {
-						logger.warn("Database has not started up yet - retrying in " + this.interval +
-								" seconds (timeout in " + rest + " seconds)");
+					if (logger.isDebugEnabled()) {
+						logger.debug("Validation query [" + this.validationQuery + "] threw exception", ex);
+					}
+					if (logger.isWarnEnabled()) {
+						float rest = ((float) (deadLine - System.currentTimeMillis())) / 1000;
+						if (rest > this.interval) {
+							logger.warn("Database has not started up yet - retrying in " + this.interval +
+									" seconds (timeout in " + rest + " seconds)");
+						}
 					}
 				}
 				finally {
@@ -140,8 +145,8 @@ public void afterPropertiesSet() {
 						"Database has not started up within " + this.timeout + " seconds", latestEx);
 			}
 
-			float duration = (System.currentTimeMillis() - beginTime) / 1000;
 			if (logger.isInfoEnabled()) {
+				float duration = ((float) (System.currentTimeMillis() - beginTime)) / 1000;
 				logger.info("Database startup detected after " + duration + " seconds");
 			}
 		}

spring-web/src/main/java/org/springframework/http/HttpHeaders.java

@@ -400,7 +400,6 @@ public HttpHeaders() {
 	 * Private constructor that can create read-only {@code HttpHeader} instances.
 	 */
 	private HttpHeaders(Map<String, List<String>> headers, boolean readOnly) {
-		Assert.notNull(headers, "'headers' must not be null");
 		if (readOnly) {
 			Map<String, List<String>> map =
 					new LinkedCaseInsensitiveMap<List<String>>(headers.size(), Locale.ENGLISH);
@@ -1319,6 +1318,7 @@ public String toString() {
 	 * Return a {@code HttpHeaders} object that can only be read, not written to.
 	 */
 	public static HttpHeaders readOnlyHttpHeaders(HttpHeaders headers) {
+		Assert.notNull(headers, "HttpHeaders must not be null");
 		return new HttpHeaders(headers, true);
 	}
 

spring-webmvc/src/main/java/org/springframework/web/servlet/HandlerExceptionResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,8 +44,8 @@ public interface HandlerExceptionResolver {
 	 * @param handler the executed handler, or {@code null} if none chosen at the
 	 * time of the exception (for example, if multipart resolution failed)
 	 * @param ex the exception that got thrown during handler execution
-	 * @return a corresponding {@code ModelAndView} to forward to, or {@code null}
-	 * for default processing
+	 * @return a corresponding {@code ModelAndView} to forward to,
+	 * or {@code null} for default processing in the resolution chain
 	 */
 	ModelAndView resolveException(
 			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);

spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerExceptionResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
 package org.springframework.web.servlet.handler;
 
 import java.util.Set;
-
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
@@ -125,8 +124,8 @@ public void setPreventResponseCaching(boolean preventResponseCaching) {
 	 * to the {@link #doResolveException} template method.
 	 */
 	@Override
-	public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response,
-			Object handler, Exception ex) {
+	public ModelAndView resolveException(
+			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
 
 		if (shouldApplyTo(request, handler)) {
 			if (this.logger.isDebugEnabled()) {
@@ -237,9 +236,10 @@ protected void preventCaching(HttpServletResponse response) {
 	 * @param handler the executed handler, or {@code null} if none chosen at the time
 	 * of the exception (for example, if multipart resolution failed)
 	 * @param ex the exception that got thrown during handler execution
-	 * @return a corresponding {@code ModelAndView} to forward to, or {@code null} for default processing
+	 * @return a corresponding {@code ModelAndView} to forward to,
+	 * or {@code null} for default processing in the resolution chain
 	 */
-	protected abstract ModelAndView doResolveException(HttpServletRequest request,
-			HttpServletResponse response, Object handler, Exception ex);
+	protected abstract ModelAndView doResolveException(
+			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
 
 }

spring-webmvc/src/main/java/org/springframework/web/servlet/handler/SimpleMappingExceptionResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -170,11 +170,12 @@ public void setExceptionAttribute(String exceptionAttribute) {
 	 * @param handler the executed handler, or {@code null} if none chosen at the time
 	 * of the exception (for example, if multipart resolution failed)
 	 * @param ex the exception that got thrown during handler execution
-	 * @return a corresponding ModelAndView to forward to, or {@code null} for default processing
+	 * @return a corresponding {@code ModelAndView} to forward to,
+	 * or {@code null} for default processing in the resolution chain
 	 */
 	@Override
-	protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response,
-			Object handler, Exception ex) {
+	protected ModelAndView doResolveException(
+			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
 
 		// Expose ModelAndView for chosen error view.
 		String viewName = determineViewName(ex, request);

spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/annotation/ResponseStatusExceptionResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -59,16 +59,16 @@ public void setMessageSource(MessageSource messageSource) {
 
 
 	@Override
-	protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response,
-			Object handler, Exception ex) {
+	protected ModelAndView doResolveException(
+			HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
 
-		ResponseStatus responseStatus = AnnotatedElementUtils.findMergedAnnotation(ex.getClass(), ResponseStatus.class);
-		if (responseStatus != null) {
+		ResponseStatus status = AnnotatedElementUtils.findMergedAnnotation(ex.getClass(), ResponseStatus.class);
+		if (status != null) {
 			try {
-				return resolveResponseStatus(responseStatus, request, response, handler, ex);
+				return resolveResponseStatus(status, request, response, handler, ex);
 			}
 			catch (Exception resolveEx) {
-				logger.warn("Handling of @ResponseStatus resulted in Exception", resolveEx);
+				logger.warn("ResponseStatus handling resulted in exception", resolveEx);
 			}
 		}
 		else if (ex.getCause() instanceof Exception) {
@@ -79,7 +79,7 @@ else if (ex.getCause() instanceof Exception) {
 	}
 
 	/**
-	 * Template method that handles {@link ResponseStatus @ResponseStatus} annotation.
+	 * Template method that handles the {@link ResponseStatus @ResponseStatus} annotation.
 	 * <p>The default implementation sends a response error using
 	 * {@link HttpServletResponse#sendError(int)} or
 	 * {@link HttpServletResponse#sendError(int, String)} if the annotation has a
@@ -88,11 +88,9 @@ else if (ex.getCause() instanceof Exception) {
 	 * @param request current HTTP request
 	 * @param response current HTTP response
 	 * @param handler the executed handler, or {@code null} if none chosen at the
-	 * time of the exception (for example, if multipart resolution failed)
-	 * @param ex the exception that got thrown during handler execution or the
-	 * exception that has the ResponseStatus annotation if found on the cause.
-	 * @return a corresponding ModelAndView to forward to, or {@code null}
-	 * for default processing
+	 * time of the exception, e.g. if multipart resolution failed
+	 * @param ex the exception
+	 * @return an empty ModelAndView, i.e. exception resolved
 	 */
 	protected ModelAndView resolveResponseStatus(ResponseStatus responseStatus, HttpServletRequest request,
 			HttpServletResponse response, Object handler, Exception ex) throws Exception {