Merge pull request #5714 from izeye/polish-201417

* pr/5714:
  Polish

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfigurationTests.java

@@ -201,7 +201,7 @@ public class DataSourceAutoConfigurationTests {
 	}
 
 	@Test
-	public void testExplicitDriverClassClearsUserName() throws Exception {
+	public void testExplicitDriverClassClearsUsername() throws Exception {
 		EnvironmentTestUtils.addEnvironment(this.context,
 				"spring.datasource.driverClassName:"
 						+ "org.springframework.boot.autoconfigure.jdbc."
@@ -302,7 +302,7 @@ public class DataSourceAutoConfigurationTests {
 
 	}
 
-	// see testExplicitDriverClassClearsUserName
+	// see testExplicitDriverClassClearsUsername
 	public static class DatabaseTestDriver implements Driver {
 
 		@Override

spring-boot-docs/src/main/asciidoc/howto.adoc

@@ -34,7 +34,7 @@ the `spring-boot-actuator` there is also an `autoconfig` endpoint that renders t
 in JSON. Use that to debug the application and see what features have been added (and
 which not) by Spring Boot at runtime.
 
-Many more questions can be answered by looking at the source code and the javadoc. Some
+Many more questions can be answered by looking at the source code and the Javadoc. Some
 rules of thumb:
 
 * Look for classes called `+*AutoConfiguration+` and read their sources, in particular the

spring-boot-docs/src/main/asciidoc/index.adoc

@@ -24,7 +24,7 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
 :sc-spring-boot-cli: {github-code}/spring-boot-cli/src/main/java/org/springframework/boot/cli
 :sc-spring-boot-devtools: {github-code}/spring-boot-devtools/src/main/java/org/springframework/boot/devtools
 :sc-spring-boot-test: {github-code}/spring-boot-test/src/main/java/org/springframework/boot/test
-:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-test/src/main/java/org/springframework/boot/test/autoconfigure
+:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure
 :dc-ext: html
 :dc-root: http://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api
 :dc-spring-boot: {dc-root}/org/springframework/boot

spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc

@@ -514,7 +514,7 @@ further information.
 == What to read next
 There are some {github-code}/spring-boot-cli/samples[sample groovy
 scripts] available from the GitHub repository that you can use to try out the
-Spring Boot CLI. There is also extensive javadoc throughout the
+Spring Boot CLI. There is also extensive Javadoc throughout the
 {sc-spring-boot-cli}[source code].
 
 If you find that you reach the limit of the CLI tool, you will probably want to look

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -4351,7 +4351,7 @@ Spring Boot provides a number of utilities and annotations to help when testing
 application. Test support is provided by two modules; `spring-boot-test` contains core
 items, and `spring-boot-test-autoconfigure` supports auto-configuration for tests.
 
-Most developers will just use the the `spring-boot-starter-test` '`Starter POM`' which
+Most developers will just use the `spring-boot-starter-test` '`Starter POM`' which
 imports both Spring Boot test modules as well has JUnit, AssertJ, Hamcrest and a number
 of other useful libraries.
 
@@ -4364,9 +4364,9 @@ If you use the
 the following provided libraries:
 
 * http://junit.org[JUnit] -- The de-facto standard for unit testing Java applications.
-* {spring-reference}/#integration-testing.html[Spring Test] & Spring Boot Test -- utilities and integration test support for Spring Boot
+* {spring-reference}/#integration-testing.html[Spring Test] & Spring Boot Test -- Utilities and integration test support for Spring Boot
   applications.
-* http://joel-costigliola.github.io/assertj/[AssertJ] - A fluent assertion library.
+* http://joel-costigliola.github.io/assertj/[AssertJ] -- A fluent assertion library.
 * http://hamcrest.org/JavaHamcrest/[Hamcrest] -- A library of matcher objects (also known
   as constraints or predicates).
 * http://mockito.org/[Mockito] -- A Java mocking framework.
@@ -4408,7 +4408,7 @@ features of Spring Boot are only installed in the context by default if you use
 `SpringApplication` to create it.
 
 Spring Boot provides a `@SpringBootTest` annotation which can be used as an
-alternative the standard `spring-test` `@ContextConfiguration` annotation when you need
+alternative to the standard `spring-test` `@ContextConfiguration` annotation when you need
 Spring Boot features. The annotation works by creating the `ApplicationContext` used
 in your tests via `SpringApplication`.
 
@@ -4425,7 +4425,7 @@ how your tests will run:
 * `DEFINED_PORT` -- Loads an `EmbeddedWebApplicationContext` and provides a real
   servlet environment. Embedded servlet containers are started and listening on a defined
   port (i.e from your `application.properties` or on the default port `8080`).
-* `NONE` -- Loads an `ApplicationContext` using `SpringApplication` but does not provides
+* `NONE` -- Loads an `ApplicationContext` using `SpringApplication` but does not provide
   _any_ servlet environment (mock or otherwise).
 
 NOTE: In addition to `@SpringBootTest` a number of other annotations are also
@@ -4533,8 +4533,8 @@ failures that might be hard to trigger in a real environment.
 Spring Boot includes a `@MockBean` annotation that can be used to define a Mockito mock
 for a bean inside your `ApplicationContext`. You can use the annotation to add new beans,
 or replace a single existing bean definition. The annotation can be used directly on test
-classes, on fields within your test; or on `@Configuration` classes and fields. When used
-on a field the, instance of the created mock will also be injected. Mock beans are
+classes, on fields within your test, or on `@Configuration` classes and fields. When used
+on a field, the instance of the created mock will also be injected. Mock beans are
 automatically reset after each test method.
 
 Here's a typical example where we replace an existing `RemoteService` bean with a mock
@@ -4574,7 +4574,7 @@ implementation:
 ----
 
 Additionally you can also use `@SpyBean` to wrap any existing bean with a Mockito `spy`.
-See the javadoc for full details.
+See the Javadoc for full details.
 
 
 [[boot-features-testing-spring-boot-applications-testing-autoconfigured-tests]]
@@ -4583,11 +4583,11 @@ Spring Boot's auto-configuration system works well for applications, but can som
 a little too much for tests. It's often helpful to load only the parts of the
 configuration that are required to test a '`slice`' of your application. For example, you
 might want to test that Spring MVC controllers are mapping URLs correctly, and you don't
-want to involve and database calls in those tests; or you _might be wanting_ to test JPA
+want to involve database calls in those tests; or you _might be wanting_ to test JPA
 entities, and you're not interested in web layer when those tests run.
 
 The `spring-boot-test-autoconfigure` module includes a number of annotations that can be
-used to automatically configure such '`slices`'. Each of them work in a similar way,
+used to automatically configure such '`slices`'. Each of them works in a similar way,
 providing a `@...Test` annotation that loads the `ApplicationContext` and one or
 more `@AutoConfigure...` annotations that can be used to customize auto-configuration
 settings.
@@ -4601,7 +4601,7 @@ TIP: It's also possible to use the `@AutoConfigure...` annotations with the stan
 [[boot-features-testing-spring-boot-applications-testing-autoconfigured-json-tests]]
 ==== Auto-configured JSON tests
 To test that Object JSON serialization and deserialization is working as expected you can
-use the `@JsonTest` annotation. `@JsonTest` will auto-configure Jackson ObjectMappers,
+use the `@JsonTest` annotation. `@JsonTest` will auto-configure Jackson `ObjectMapper`,
 any `@JsonComponent` beans and any Jackson `Modules`. It also configures `Gson`
 if you happen to be using that instead of, or as well as, Jackson. If you need to
 configure elements of the auto-configuration you can use the `@AutoConfigureJsonTesters`
@@ -4751,7 +4751,7 @@ and/or a `WebDriver` bean. Here is an example that uses HtmlUnit:
 
 [[boot-features-testing-spring-boot-applications-testing-autoconfigured-jpa-test]]
 ==== Auto-configured Data JPA tests
-The `@DataJpaTest` can be used if want to test JPA applications. By default it will
+The `@DataJpaTest` can be used if you want to test JPA applications. By default it will
 configure an in-memory embedded database, scan for `@Entity` classes and configure Spring
 Data JPA repositories. Regular `@Component` beans will not be loaded into the
 `ApplicationContext`.

spring-boot-samples/spring-boot-sample-test/src/main/java/sample/test/domain/User.java

@@ -50,7 +50,7 @@ public class User {
 		this.vin = vin;
 	}
 
-	protected Long getId() {
+	public Long getId() {
 		return this.id;
 	}
 

spring-boot-samples/spring-boot-sample-test/src/main/java/sample/test/domain/UserRepository.java

@@ -19,7 +19,7 @@ package sample.test.domain;
 import org.springframework.data.repository.Repository;
 
 /**
- * Domain repository for {@link User}
+ * Domain repository for {@link User}.
  *
  * @author Phillip Webb
  */

spring-boot-samples/spring-boot-sample-test/src/main/java/sample/test/web/UserVehicleController.java

@@ -29,7 +29,7 @@ import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
- * Controller to return vehicle information for a given {@link User}
+ * Controller to return vehicle information for a given {@link User}.
  *
  * @author Phillip Webb
  */

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/SampleTestApplicationWebIntegrationTests.java

@@ -34,7 +34,7 @@ import org.springframework.test.context.junit4.SpringRunner;
 import static org.mockito.BDDMockito.given;
 
 /**
- * {@code @WebIntegrationTest} for {@link SampleTestApplication}.
+ * {@code @SpringBootTest} with a random port for {@link SampleTestApplication}.
  *
  * @author Phillip Webb
  */

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/domain/UserEntityTests.java

@@ -47,14 +47,14 @@ public class UserEntityTests {
 	private TestEntityManager entityManager;
 
 	@Test
-	public void createWhenUserIdIsNullShouldThrowException() throws Exception {
+	public void createWhenUsernameIsNullShouldThrowException() throws Exception {
 		this.thrown.expect(IllegalArgumentException.class);
 		this.thrown.expectMessage("Username must not be empty");
 		new User(null, VIN);
 	}
 
 	@Test
-	public void createWhenUserIdIsEmptyShouldThrowException() throws Exception {
+	public void createWhenUsernameIsEmptyShouldThrowException() throws Exception {
 		this.thrown.expect(IllegalArgumentException.class);
 		this.thrown.expectMessage("Username must not be empty");
 		new User("", VIN);

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/domain/VehicleIdentificationNumberTests.java

@@ -65,7 +65,7 @@ public class VehicleIdentificationNumberTests {
 	}
 
 	@Test
-	public void equalsAndHashShouldBeBasedOnVin() throws Exception {
+	public void equalsAndHashCodeShouldBeBasedOnVin() throws Exception {
 		VehicleIdentificationNumber vin1 = new VehicleIdentificationNumber(SAMPLE_VIN);
 		VehicleIdentificationNumber vin2 = new VehicleIdentificationNumber(SAMPLE_VIN);
 		VehicleIdentificationNumber vin3 = new VehicleIdentificationNumber(

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/service/VehicleDetailsJsonTests.java

@@ -26,7 +26,7 @@ import org.springframework.test.context.junit4.SpringRunner;
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * JSON Tests for {@link VehicleDetails}.
+ * JSON tests for {@link VehicleDetails}.
  *
  * @author Phillip Webb
  */

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/web/UserVehicleControllerApplicationTests.java

@@ -67,7 +67,7 @@ public class UserVehicleControllerApplicationTests {
 
 	@Test
 	public void welcomeCommandLineRunnerShouldBeAvailable() throws Exception {
-		// Since we're a @SpringApplicationTest all beans should be available
+		// Since we're a @SpringBootTest all beans should be available.
 		assertThat(this.applicationContext.getBean(WelcomeCommandLineRunner.class))
 				.isNotNull();
 	}

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/web/UserVehicleControllerTests.java

@@ -102,7 +102,7 @@ public class UserVehicleControllerTests {
 
 	@Test(expected = NoSuchBeanDefinitionException.class)
 	public void welcomeCommandLineRunnerShouldBeAvailable() throws Exception {
-		// Since we're a @WebMvcTest WelcomeCommandLineRunner should not be available
+		// Since we're a @WebMvcTest WelcomeCommandLineRunner should not be available.
 		assertThat(this.applicationContext.getBean(WelcomeCommandLineRunner.class));
 	}
 

spring-boot-samples/spring-boot-sample-test/src/test/java/sample/test/web/UserVehicleServiceTests.java

@@ -69,7 +69,7 @@ public class UserVehicleServiceTests {
 	}
 
 	@Test
-	public void getVehicleDetailsWhenUserNameNotFoundShouldThrowException()
+	public void getVehicleDetailsWhenUsernameNotFoundShouldThrowException()
 			throws Exception {
 		given(this.userRepository.findByUsername(anyString())).willReturn(null);
 		this.thrown.expect(UserNameNotFoundException.class);

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/orm/jpa/AutoConfigureTestDatabase.java

@@ -49,7 +49,7 @@ public @interface AutoConfigureTestDatabase {
 	Replace replace() default Replace.ANY;
 
 	/**
-	 * The type of connection to be establish when {@link #replace() replacing} the data
+	 * The type of connection to be established when {@link #replace() replacing} the data
 	 * source. By default will attempt to detect the connection based on the classpath.
 	 * @return the type of connection to use
 	 */

spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure/orm/jpa/AutoConfigureTestEntityManager.java

@@ -25,7 +25,7 @@ import java.lang.annotation.Target;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 
 /**
- * Annotation that can be applied to a test class to enable and configure
+ * Annotation that can be applied to a test class to enable
  * auto-configuration of a {@link TestEntityManager}.
  *
  * @author Phillip Webb

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/orm/jpa/DataJpaTestIntegrationTests.java

@@ -80,7 +80,7 @@ public class DataJpaTestIntegrationTests {
 	}
 
 	@Test
-	public void replacesDefinedDatasourceWithEmbeddedDefault() throws Exception {
+	public void replacesDefinedDataSourceWithEmbeddedDefault() throws Exception {
 		String product = this.dataSource.getConnection().getMetaData()
 				.getDatabaseProductName();
 		assertThat(product).isEqualTo("H2");

spring-boot-test-autoconfigure/src/test/java/org/springframework/boot/test/autoconfigure/orm/jpa/DataJpaTestWithAutoConfigureTestDatabaseReplaceExplicitIntegrationTests.java

@@ -61,8 +61,8 @@ public class DataJpaTestWithAutoConfigureTestDatabaseReplaceExplicitIntegrationT
 	}
 
 	@Test
-	public void replacesDefinedDatasourceWithExplicit() throws Exception {
-		// H2 is explicitly defined by HSQL is the override
+	public void replacesDefinedDataSourceWithExplicit() throws Exception {
+		// H2 is explicitly defined but HSQL is the override.
 		String product = this.dataSource.getConnection().getMetaData()
 				.getDatabaseProductName();
 		assertThat(product).startsWith("HSQL");

spring-boot/src/main/java/org/springframework/boot/jackson/JsonObjectDeserializer.java

@@ -62,7 +62,7 @@ public abstract class JsonObjectDeserializer<T>
 	/**
 	 * Deserialize JSON content into the value type this serializer handles.
 	 * @param jsonParser the source parser used for reading JSON content
-	 * @param context Context that can be used to access information about this
+	 * @param context context that can be used to access information about this
 	 * deserialization activity
 	 * @param codec the {@link ObjectCodec} associated with the parser
 	 * @param tree deserialized JSON content as tree expressed using set of
@@ -76,7 +76,7 @@ public abstract class JsonObjectDeserializer<T>
 					throws IOException;
 
 	/**
-	 * Helper method to extract a value from the given jsonNode or return {@code null}
+	 * Helper method to extract a value from the given {@code jsonNode} or return {@code null}
 	 * when the node itself is {@code null}.
 	 * @param jsonNode the source node (may be {@code null}
 	 * @param type the data type. May be {@link String}, {@link Boolean}, {@link Long},

spring-boot/src/main/java/org/springframework/boot/jackson/package-info.java

@@ -15,6 +15,6 @@
  */
 
 /**
- * Custom enhancements and support for the Jackson Project.
+ * Custom enhancements and support for the Jackson project.
  */
 package org.springframework.boot.jackson;

spring-boot/src/test/java/org/springframework/boot/context/embedded/EmbeddedServletContainerMvcIntegrationTests.java

@@ -153,7 +153,7 @@ public class EmbeddedServletContainerMvcIntegrationTests {
 			return new DispatcherServlet();
 			// Alternatively you can use ServletContextInitializer beans including
 			// ServletRegistration and FilterRegistration. Read the
-			// EmbeddedWebApplicationContext javadoc for details
+			// EmbeddedWebApplicationContext Javadoc for details.
 		}
 
 		@Bean

spring-boot/src/test/java/org/springframework/boot/jackson/JsonObjectDeserializerTests.java

@@ -133,7 +133,7 @@ public class JsonObjectDeserializerTests {
 	}
 
 	@Test
-	public void nullSafeValueWhenClassIsShouldBigDecimalReturnBigDecimal()
+	public void nullSafeValueWhenClassIsBigDecimalShouldReturnBigDecimal()
 			throws Exception {
 		JsonNode node = mock(JsonNode.class);
 		given(node.decimalValue()).willReturn(BigDecimal.TEN);