Polishing

Author: jhoeller

spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassBeanDefinitionReader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 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.
@@ -186,7 +186,7 @@ private void loadBeanDefinitionsForBeanMethod(BeanMethod beanMethod) {
 		// Consider name and any aliases
 		AnnotationAttributes bean = AnnotationConfigUtils.attributesFor(metadata, Bean.class);
 		List<String> names = new ArrayList<String>(Arrays.asList(bean.getStringArray("name")));
-		String beanName = (names.size() > 0 ? names.remove(0) : methodName);
+		String beanName = (!names.isEmpty() ? names.remove(0) : methodName);
 
 		// Register aliases even when overridden
 		for (String alias : names) {
@@ -336,7 +336,7 @@ private void loadBeanDefinitionsFromImportedResources(
 					}
 					readerInstanceCache.put(readerClass, reader);
 				}
-				catch (Exception ex) {
+				catch (Throwable ex) {
 					throw new IllegalStateException(
 							"Could not instantiate BeanDefinitionReader class [" + readerClass.getName() + "]");
 				}

spring-jdbc/src/main/java/org/springframework/jdbc/core/metadata/CallParameterMetaData.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2007 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.
@@ -21,16 +21,23 @@
  *
  * @author Thomas Risberg
  * @since 2.5
+ * @see GenericCallMetaDataProvider
  */
 public class CallParameterMetaData {
+
 	private String parameterName;
+
 	private int parameterType;
+
 	private int sqlType;
+
 	private String typeName;
+
 	private boolean nullable;
 
+
 	/**
-	 * Constructor taking all the properties
+	 * Constructor taking all the properties.
 	 */
 	public CallParameterMetaData(String columnName, int columnType, int sqlType, String typeName, boolean nullable) {
 		this.parameterName = columnName;
@@ -45,34 +52,35 @@ public CallParameterMetaData(String columnName, int columnType, int sqlType, Str
 	 * Get the parameter name.
 	 */
 	public String getParameterName() {
-		return parameterName;
+		return this.parameterName;
 	}
 
 	/**
 	 * Get the parameter type.
 	 */
 	public int getParameterType() {
-		return parameterType;
+		return this.parameterType;
 	}
 
 	/**
 	 * Get the parameter SQL type.
 	 */
 	public int getSqlType() {
-		return sqlType;
+		return this.sqlType;
 	}
 
 	/**
 	 * Get the parameter type name.
 	 */
 	public String getTypeName() {
-		return typeName;
+		return this.typeName;
 	}
 
 	/**
 	 * Get whether the parameter is nullable.
 	 */
 	public boolean isNullable() {
-		return nullable;
+		return this.nullable;
 	}
+
 }

spring-jdbc/src/main/java/org/springframework/jdbc/core/metadata/TableParameterMetaData.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2007 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.
@@ -21,6 +21,7 @@
  *
  * @author Thomas Risberg
  * @since 2.5
+ * @see GenericTableMetaDataProvider
  */
 public class TableParameterMetaData {
 

spring-orm/src/main/java/org/springframework/orm/jpa/EntityManagerFactoryUtils.java

@@ -450,7 +450,8 @@ public static void closeEntityManager(EntityManager em) {
 
 	/**
 	 * Callback for resource cleanup at the end of a non-JPA transaction
-	 * (e.g. when participating in a JtaTransactionManager transaction).
+	 * (e.g. when participating in a JtaTransactionManager transaction),
+	 * fully synchronized with the ongoing transaction.
 	 * @see org.springframework.transaction.jta.JtaTransactionManager
 	 */
 	private static class TransactionalEntityManagerSynchronization
@@ -465,6 +466,7 @@ private static class TransactionalEntityManagerSynchronization
 
 		public TransactionalEntityManagerSynchronization(
 				EntityManagerHolder emHolder, EntityManagerFactory emf, Object txData, boolean newEm) {
+
 			super(emHolder, emf);
 			this.transactionData = txData;
 			this.jpaDialect = (emf instanceof EntityManagerFactoryInfo ?
@@ -512,7 +514,9 @@ protected void releaseResource(EntityManagerHolder resourceHolder, EntityManager
 		}
 
 		@Override
-		protected void cleanupResource(EntityManagerHolder resourceHolder, EntityManagerFactory resourceKey, boolean committed) {
+		protected void cleanupResource(
+				EntityManagerHolder resourceHolder, EntityManagerFactory resourceKey, boolean committed) {
+
 			if (!committed) {
 				// Clear all pending inserts/updates/deletes in the EntityManager.
 				// Necessary for pre-bound EntityManagers, to avoid inconsistent state.

spring-test/src/test/java/org/springframework/test/context/testng/TrackingTestNGTestListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 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.
@@ -30,8 +30,11 @@
 public class TrackingTestNGTestListener implements ITestListener {
 
 	public int testStartCount = 0;
+
 	public int testSuccessCount = 0;
+
 	public int testFailureCount = 0;
+
 	public int failedConfigurationsCount = 0;
 
 
@@ -66,4 +69,5 @@ public void onTestStart(ITestResult testResult) {
 	public void onTestSuccess(ITestResult testResult) {
 		this.testSuccessCount++;
 	}
-}
+
+}

spring-web/src/main/java/org/springframework/http/client/SimpleClientHttpRequestFactory.java

@@ -64,13 +64,15 @@ public void setProxy(Proxy proxy) {
 	}
 
 	/**
-	 * Indicates whether this request factory should buffer the {@linkplain ClientHttpRequest#getBody() request body}
-	 * internally.
-	 * <p>Default is {@code true}. When sending large amounts of data via POST or PUT, it is recommended
-	 * to change this property to {@code false}, so as not to run out of memory. This will result in a
-	 * {@link ClientHttpRequest} that either streams directly to the underlying {@link HttpURLConnection}
-	 * (if the {@link org.springframework.http.HttpHeaders#getContentLength() Content-Length} is known in advance),
-	 * or that will use "Chunked transfer encoding" (if the {@code Content-Length} is not known in advance).
+	 * Indicate whether this request factory should buffer the
+	 * {@linkplain ClientHttpRequest#getBody() request body} internally.
+	 * <p>Default is {@code true}. When sending large amounts of data via POST or PUT,
+	 * it is recommended to change this property to {@code false}, so as not to run
+	 * out of memory. This will result in a {@link ClientHttpRequest} that either
+	 * streams directly to the underlying {@link HttpURLConnection} (if the
+	 * {@link org.springframework.http.HttpHeaders#getContentLength() Content-Length}
+	 * is known in advance), or that will use "Chunked transfer encoding"
+	 * (if the {@code Content-Length} is not known in advance).
 	 * @see #setChunkSize(int)
 	 * @see HttpURLConnection#setFixedLengthStreamingMode(int)
 	 */
@@ -79,9 +81,11 @@ public void setBufferRequestBody(boolean bufferRequestBody) {
 	}
 
 	/**
-	 * Sets the number of bytes to write in each chunk when not buffering request bodies locally.
-	 * <p>Note that this parameter is only used when {@link #setBufferRequestBody(boolean) bufferRequestBody} is set
-	 * to {@code false}, and the {@link org.springframework.http.HttpHeaders#getContentLength() Content-Length}
+	 * Set the number of bytes to write in each chunk when not buffering request
+	 * bodies locally.
+	 * <p>Note that this parameter is only used when
+	 * {@link #setBufferRequestBody(boolean) bufferRequestBody} is set to {@code false},
+	 * and the {@link org.springframework.http.HttpHeaders#getContentLength() Content-Length}
 	 * is not known in advance.
 	 * @see #setBufferRequestBody(boolean)
 	 */

spring-web/src/main/java/org/springframework/web/bind/WebDataBinder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 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.
@@ -248,11 +248,11 @@ protected void checkFieldMarkers(MutablePropertyValues mpvs) {
 	 * Determine an empty value for the specified field.
 	 * <p>Default implementation returns:
 	 * <ul>
-	 *     <li>{@code Boolean.FALSE} for boolean fields
-	 *     <li>an empty array for array types
-	 *     <li>Collection implementations for Collection types
-	 *     <li>Map implementations for Map types
-	 *     <li>else, {@code null} is used as default
+	 * <li>{@code Boolean.FALSE} for boolean fields
+	 * <li>an empty array for array types
+	 * <li>Collection implementations for Collection types
+	 * <li>Map implementations for Map types
+	 * <li>else, {@code null} is used as default
 	 * </ul>
 	 * @param field the name of the field
 	 * @param fieldType the type of the field

spring-web/src/main/java/org/springframework/web/client/ResponseErrorHandler.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.
@@ -21,28 +21,31 @@
 import org.springframework.http.client.ClientHttpResponse;
 
 /**
- * Strategy interface used by the {@link RestTemplate} to determine whether a particular response has an error or not.
+ * Strategy interface used by the {@link RestTemplate} to determine
+ * whether a particular response has an error or not.
  *
  * @author Arjen Poutsma
  * @since 3.0
  */
 public interface ResponseErrorHandler {
 
 	/**
-	 * Indicates whether the given response has any errors.
-	 * Implementations will typically inspect the {@link ClientHttpResponse#getStatusCode() HttpStatus}
-	 * of the response.
+	 * Indicate whether the given response has any errors.
+	 * <p>Implementations will typically inspect the
+	 * {@link ClientHttpResponse#getStatusCode() HttpStatus} of the response.
 	 * @param response the response to inspect
 	 * @return {@code true} if the response has an error; {@code false} otherwise
 	 * @throws IOException in case of I/O errors
 	 */
 	boolean hasError(ClientHttpResponse response) throws IOException;
 
 	/**
-	 * Handles the error in the given response.
-	 * This method is only called when {@link #hasError(ClientHttpResponse)} has returned {@code true}.
+	 * Handle the error in the given response.
+	 * <p>This method is only called when {@link #hasError(ClientHttpResponse)}
+	 * has returned {@code true}.
 	 * @param response the response with the error
 	 * @throws IOException in case of I/O errors
 	 */
 	void handleError(ClientHttpResponse response) throws IOException;
+
 }