Polish

Closes gh-5815

Author: izeye

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/NamePatternFilter.java

@@ -27,7 +27,7 @@
  * must provide implementations of {@link #getValue(Object, String)} and
  * {@link #getNames(Object, NameCallback)}.
  *
- * @param <T> The source data type
+ * @param <T> the source data type
  * @author Phillip Webb
  * @author Sergei Egorov
  * @author Andy Wilkinson

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/buffer/Buffer.java

@@ -19,7 +19,7 @@
 /**
  * Base class for a mutable buffer containing a timestamp and a value.
  *
- * @param <T> The value type
+ * @param <T> the value type
  * @author Dave Syer
  * @author Phillip Webb
  */

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizer.java

@@ -22,7 +22,7 @@
  * Callback interface that can be implemented by beans wishing to customize the cache
  * manager before it is fully initialized, in particular to tune its configuration.
  *
- * @param <T> The type of the {@link CacheManager}
+ * @param <T> the type of the {@link CacheManager}
  * @author Stephane Nicoll
  * @since 1.3.3
  */

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/AbstractDataSourcePoolMetadata.java

@@ -21,7 +21,7 @@
 /**
  * A base {@link DataSourcePoolMetadata} implementation.
  *
- * @param <T> The datasource type
+ * @param <T> the data source type
  * @author Stephane Nicoll
  * @since 1.2.0
  */

spring-boot-test/src/main/java/org/springframework/boot/test/json/AbstractJsonMarshalTester.java

@@ -53,7 +53,7 @@
  *     public void testWriteJson() {
  *         ExampleObject object = //...
  *         assertThat(json.write(object)).isEqualToJson("expected.json");
- *         assertThat(json.read("expected.json)).isEqualTo(object);
+ *         assertThat(json.read("expected.json")).isEqualTo(object);
  *     }
  *
  * }
@@ -62,7 +62,7 @@
  * <p>
  * To use this library JSONAssert must be on the test classpath.
  *
- * @param <T> The type under test
+ * @param <T> the type under test
  * @author Phillip Webb
  * @since 1.4.0
  * @see JsonContentAssert
@@ -271,8 +271,8 @@ private void closeQuietly(Closeable closeable) {
 
 	/**
 	 * Write the specified object to a JSON string.
-	 * @param value the source value ({@code never null})
-	 * @param type the resulting type ({@code never null})
+	 * @param value the source value (never {@code null})
+	 * @param type the resulting type (never {@code null})
 	 * @return the JSON string
 	 * @throws IOException on write error
 	 */
@@ -281,9 +281,9 @@ protected abstract String writeObject(T value, ResolvableType type)
 
 	/**
 	 * Read from the specified input stream to create an object of the specified type. The
-	 * default implementation delegates to {@link #readObject(Reader, ResolvableType)}
-	 * @param inputStream the source input stream ({@code never null})
-	 * @param type the resulting type ({@code never null})
+	 * default implementation delegates to {@link #readObject(Reader, ResolvableType)}.
+	 * @param inputStream the source input stream (never {@code null})
+	 * @param type the resulting type (never {@code null})
 	 * @return the resulting object
 	 * @throws IOException on read error
 	 */
@@ -295,16 +295,16 @@ protected T readObject(InputStream inputStream, ResolvableType type)
 
 	/**
 	 * Read from the specified reader to create an object of the specified type.
-	 * @param reader the source reader ({@code never null})
-	 * @param type the resulting type ({@code never null})
+	 * @param reader the source reader (never {@code null})
+	 * @param type the resulting type (never {@code null})
 	 * @return the resulting object
 	 * @throws IOException on read error
 	 */
 	protected abstract T readObject(Reader reader, ResolvableType type)
 			throws IOException;
 
 	/**
-	 * Utility class used to support field initialization. Uses by subclasses to support
+	 * Utility class used to support field initialization. Used by subclasses to support
 	 * {@code initFields}.
 	 * @param <M> The marshaller type
 	 */

spring-boot-test/src/main/java/org/springframework/boot/test/json/BasicJsonTester.java

@@ -24,13 +24,13 @@
 
 /**
  * AssertJ based JSON tester that works with basic JSON strings. Allows testing of JSON
- * payloads created from some any source, for example:<pre class="code">
+ * payloads created from any source, for example:<pre class="code">
  * public class ExampleObjectJsonTests {
  *
- *     private BasicJsonTester = new BasicJsonTester(getClass());
+ *     private BasicJsonTester json = new BasicJsonTester(getClass());
  *
  *     &#064;Test
- *     public void testWriteJson() {
+ *     public void testWriteJson() throws IOException {
  *         assertThat(json.from("example.json")).extractingJsonPathStringValue("@.name")
 				.isEqualTo("Spring");
  *     }
@@ -70,7 +70,7 @@ public JsonContent<Object> from(CharSequence source) {
 	/**
 	 * Create JSON content from the specified resource path.
 	 * @param path the path of the resource to load
-	 * @param resourceLoadClass the classloader used load the resource
+	 * @param resourceLoadClass the source class used to load the resource
 	 * @return the JSON content
 	 */
 	public JsonContent<Object> from(String path, Class<?> resourceLoadClass) {

spring-boot-test/src/main/java/org/springframework/boot/test/json/GsonTester.java

@@ -39,7 +39,7 @@
  *     }
  *
  *     @Test
- *     public void testWriteJson() {
+ *     public void testWriteJson() throws IOException {
  *         ExampleObject object = //...
  *         assertThat(json.write(object)).isEqualToJson("expected.json");
  *     }
@@ -49,7 +49,7 @@
  *
  * See {@link AbstractJsonMarshalTester} for more details.
  *
- * @param <T> The type under test
+ * @param <T> the type under test
  * @author Phillip Webb
  * @since 1.4.0
  */
@@ -81,7 +81,7 @@ protected T readObject(Reader reader, ResolvableType type) throws IOException {
 	}
 
 	/**
-	 * Utility method to initialize {@link JacksonTester} fields. See {@link JacksonTester
+	 * Utility method to initialize {@link GsonTester} fields. See {@link GsonTester
 	 * class-level documentation} for example usage.
 	 * @param testInstance the test instance
 	 * @param gson the Gson instance
@@ -91,7 +91,7 @@ public static void initFields(Object testInstance, Gson gson) {
 	}
 
 	/**
-	 * Utility method to initialize {@link JacksonTester} fields. See {@link JacksonTester
+	 * Utility method to initialize {@link GsonTester} fields. See {@link GsonTester
 	 * class-level documentation} for example usage.
 	 * @param testInstance the test instance
 	 * @param gson an object factory to create the Gson instance
@@ -101,7 +101,7 @@ public static void initFields(Object testInstance, ObjectFactory<Gson> gson) {
 	}
 
 	/**
-	 * {@link JsonTesterFieldInitializer} for Gson.
+	 * {@link FieldInitializer} for Gson.
 	 */
 	private static class GsonFieldInitializer extends FieldInitializer<Gson> {
 

spring-boot-test/src/main/java/org/springframework/boot/test/json/JacksonTester.java

@@ -41,7 +41,7 @@
  *     }
  *
  *     @Test
- *     public void testWriteJson() {
+ *     public void testWriteJson() throws IOException {
  *         ExampleObject object = //...
  *         assertThat(json.write(object)).isEqualToJson("expected.json");
  *     }
@@ -51,7 +51,7 @@
  *
  * See {@link AbstractJsonMarshalTester} for more details.
  *
- * @param <T> The type under test
+ * @param <T> the type under test
  * @author Phillip Webb
  * @since 1.4.0
  */
@@ -116,7 +116,7 @@ public static void initFields(Object testInstance,
 	}
 
 	/**
-	 * {@link JsonTesterFieldInitializer} for Jackson.
+	 * {@link FieldInitializer} for Jackson.
 	 */
 	private static class JacksonFieldInitializer extends FieldInitializer<ObjectMapper> {
 

spring-boot-test/src/main/java/org/springframework/boot/test/json/JsonContent.java

@@ -26,7 +26,7 @@
  * {@link AssertProvider provide} {@link JsonContentAssert} to AssertJ {@code assertThat}
  * calls.
  *
- * @param <T> The source type that created the content
+ * @param <T> the source type that created the content
  * @author Phillip Webb
  * @since 1.4.0
  */

spring-boot-test/src/main/java/org/springframework/boot/test/json/JsonContentAssert.java

@@ -843,7 +843,7 @@ public JsonContentAssert hasEmptyJsonPathValue(CharSequence expression,
 	/**
 	 * Verify that the actual value at the given JSON path produces no result. If the JSON
 	 * path expression is not {@linkplain JsonPath#isDefinite() definite}, this method
-	 * verifies that the value at the given path is not <em>empty</em>.
+	 * verifies that the value at the given path is <em>empty</em>.
 	 * @param expression the {@link JsonPath} expression
 	 * @param args arguments to parameterize the {@code JsonPath} expression with, using
 	 * formatting specifiers defined in {@link String#format(String, Object...)}
@@ -990,7 +990,7 @@ private JSONCompareResult compareForNull(CharSequence expectedJson) {
 		JSONCompareResult result = new JSONCompareResult();
 		result.passed();
 		if (expectedJson != null) {
-			result.fail("Expected non-null JSON");
+			result.fail("Expected null JSON");
 		}
 		return result;
 	}
@@ -1079,7 +1079,7 @@ public Object getValue(boolean required) {
 				if (!required) {
 					return null;
 				}
-				throw new AssertionError(getNoValueMessage() + ex.getMessage());
+				throw new AssertionError(getNoValueMessage() + ". " + ex.getMessage());
 			}
 		}
 

spring-boot-test/src/main/java/org/springframework/boot/test/json/ObjectContent.java

@@ -22,11 +22,11 @@
 import org.springframework.util.Assert;
 
 /**
- * Object content usually created from {@link AbstractJsonMarshalTester}.Generally used
+ * Object content usually created from {@link AbstractJsonMarshalTester}. Generally used
  * only to {@link AssertProvider provide} {@link ObjectContentAssert} to AssertJ
  * {@code assertThat} calls.
  *
- * @param <T> The content type
+ * @param <T> the content type
  * @author Phillip Webb
  * @since 1.4.0
  */

spring-boot-test/src/main/java/org/springframework/boot/test/json/ObjectContentAssert.java

@@ -26,7 +26,7 @@
 import org.assertj.core.internal.Objects;
 
 /**
- * AssertJ {@link Assert} for {@link JsonContent}.
+ * AssertJ {@link Assert} for {@link ObjectContent}.
  *
  * @param <A> The actual type
  * @author Phillip Webb
@@ -42,7 +42,7 @@ protected ObjectContentAssert(A actual) {
 	/**
 	 * Verifies that the actual value is an array, and returns an array assertion, to
 	 * allow chaining of array-specific assertions from this call.
-	 * @return a list assertion object
+	 * @return an array assertion object
 	 */
 	public AbstractObjectArrayAssert<?, Object> asArray() {
 		Objects.instance().assertIsInstanceOf(this.info, this.actual, Object[].class);
@@ -51,8 +51,8 @@ public AbstractObjectArrayAssert<?, Object> asArray() {
 
 	/**
 	 * Verifies that the actual value is a map, and returns a map assertion, to allow
-	 * chaining of list-specific assertions from this call.
-	 * @return a list assertion object
+	 * chaining of map-specific assertions from this call.
+	 * @return a map assertion object
 	 */
 	@SuppressWarnings("unchecked")
 	public AbstractMapAssert<?, ?, Object, Object> asMap() {

spring-boot-test/src/test/java/org/springframework/boot/test/json/AbstractJsonMarshalTesterTests.java

@@ -192,7 +192,7 @@ protected abstract AbstractJsonMarshalTester<Object> createTester(
 			Class<?> resourceLoadClass, ResolvableType type);
 
 	/**
-	 * Access to field backed {@link ResolvableType}.
+	 * Access to field backed by {@link ResolvableType}.
 	 */
 	public static class ResolvableTypes {
 

spring-boot-test/src/test/java/org/springframework/boot/test/json/GsonTesterTests.java

@@ -41,7 +41,7 @@ public void initFieldsWhenTestIsNullShouldThrowException() {
 	}
 
 	@Test
-	public void initFieldsWhenObjectMapperIsNullShouldThrowException() {
+	public void initFieldsWhenMarshallerIsNullShouldThrowException() {
 		this.thrown.expect(IllegalArgumentException.class);
 		this.thrown.expectMessage("Marshaller must not be null");
 		GsonTester.initFields(new InitFieldsTestClass(), (Gson) null);

spring-boot-test/src/test/java/org/springframework/boot/test/json/JacksonTesterTests.java

@@ -40,7 +40,7 @@ public void initFieldsWhenTestIsNullShouldThrowException() {
 	}
 
 	@Test
-	public void initFieldsWhenObjectMapperIsNullShouldThrowException() {
+	public void initFieldsWhenMarshallerIsNullShouldThrowException() {
 		this.thrown.expect(IllegalArgumentException.class);
 		this.thrown.expectMessage("Marshaller must not be null");
 		JacksonTester.initFields(new InitFieldsTestClass(), (ObjectMapper) null);