Merge pull request #4455 from izeye/polish-20151113

snicoll · snicoll · commit 54604805ae2c · 2015-11-13T10:15:38.000+01:00
* pr/4455:
  Polish
diff --git a/spring-boot/src/main/java/org/springframework/boot/ApplicationHome.java b/spring-boot/src/main/java/org/springframework/boot/ApplicationHome.java
@@ -95,7 +95,7 @@ private File findDefaultHomeDir() {
 	}
 
 	/**
-	 * Returns the underlying source used to find the home folder. This is usually the jar
+	 * Returns the underlying source used to find the home directory. This is usually the jar
 	 * file or a directory. Can return {@code null} if the source cannot be determined.
 	 * @return the underlying source or {@code null}
 	 */
@@ -104,8 +104,8 @@ public File getSource() {
 	}
 
 	/**
-	 * Returns the application home folder.
-	 * @return the home folder (never {@code null})
+	 * Returns the application home directory.
+	 * @return the home directory (never {@code null})
 	 */
 	public File getDir() {
 		return this.dir;
diff --git a/spring-boot/src/main/java/org/springframework/boot/cloud/CloudPlatform.java b/spring-boot/src/main/java/org/springframework/boot/cloud/CloudPlatform.java
@@ -20,7 +20,7 @@
 
 /**
  * Simple detection for well known cloud platforms. For more advanced cloud provider
- * integration consider the Spring Clould project.
+ * integration consider the Spring Cloud project.
  *
  * @author Phillip Webb
  * @since 1.3.0
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/AbstractConfigurableEmbeddedServletContainer.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/AbstractConfigurableEmbeddedServletContainer.java
@@ -331,7 +331,7 @@ protected final ServletContextInitializer[] mergeInitializers(
 	}
 
 	/**
-	 * Returns whether or not he JSP servlet should be registered with the embedded
+	 * Returns whether or not the JSP servlet should be registered with the embedded
 	 * container.
 	 * @return {@code true} if the container should be registered, otherwise {@code false}
 	 */
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/AbstractEmbeddedServletContainerFactory.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/AbstractEmbeddedServletContainerFactory.java
@@ -59,7 +59,7 @@ public AbstractEmbeddedServletContainerFactory(String contextPath, int port) {
 	}
 
 	/**
-	 * Returns the absolute document root when it points to a valid folder, logging a
+	 * Returns the absolute document root when it points to a valid directory, logging a
 	 * warning and returning {@code null} otherwise.
 	 * @return the valid document root
 	 */
@@ -171,15 +171,15 @@ protected final File getValidSessionStoreDir(boolean mkdirs) {
 	 */
 	protected File createTempDir(String prefix) {
 		try {
-			File tempFolder = File.createTempFile(prefix + ".", "." + getPort());
-			tempFolder.delete();
-			tempFolder.mkdir();
-			tempFolder.deleteOnExit();
-			return tempFolder;
+			File tempDir = File.createTempFile(prefix + ".", "." + getPort());
+			tempDir.delete();
+			tempDir.mkdir();
+			tempDir.deleteOnExit();
+			return tempDir;
 		}
 		catch (IOException ex) {
 			throw new EmbeddedServletContainerException(
-					"Unable to create tempdir. java.io.tmpdir is set to "
+					"Unable to create tempDir. java.io.tmpdir is set to "
 							+ System.getProperty("java.io.tmpdir"),
 					ex);
 		}
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/ConfigurableEmbeddedServletContainer.java
@@ -144,7 +144,7 @@ public interface ConfigurableEmbeddedServletContainer {
 	void setMimeMappings(MimeMappings mimeMappings);
 
 	/**
-	 * Sets the document root folder which will be used by the web context to serve static
+	 * Sets the document root directory which will be used by the web context to serve static
 	 * files.
 	 * @param documentRoot the document root or {@code null} if not required
 	 */
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactory.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactory.java
@@ -411,8 +411,8 @@ private void configurePersistSession(Manager manager) {
 		Assert.state(manager instanceof StandardManager,
 				"Unable to persist HTTP session state using manager type "
 						+ manager.getClass().getName());
-		File folder = getValidSessionStoreDir();
-		File file = new File(folder, "SESSIONS.ser");
+		File dir = getValidSessionStoreDir();
+		File file = new File(dir, "SESSIONS.ser");
 		((StandardManager) manager).setPathname(file.getAbsolutePath());
 	}
 
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/tomcat/TomcatResources.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/tomcat/TomcatResources.java
@@ -116,7 +116,7 @@ private static class Tomcat7Resources extends TomcatResources {
 
 		@Override
 		protected void addJar(String jar) {
-			URL url = getJarUlr(jar);
+			URL url = getJarUrl(jar);
 			if (url != null) {
 				try {
 					this.addResourceJarUrlMethod.invoke(getContext(), url);
@@ -127,7 +127,7 @@ protected void addJar(String jar) {
 			}
 		}
 
-		private URL getJarUlr(String jar) {
+		private URL getJarUrl(String jar) {
 			try {
 				return new URL(jar);
 			}
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/undertow/FileSessionPersistence.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/undertow/FileSessionPersistence.java
@@ -38,10 +38,10 @@
  */
 public class FileSessionPersistence implements SessionPersistenceManager {
 
-	private final File folder;
+	private final File dir;
 
-	public FileSessionPersistence(File folder) {
-		this.folder = folder;
+	public FileSessionPersistence(File dir) {
+		this.dir = dir;
 	}
 
 	@Override
@@ -124,10 +124,10 @@ private Map<String, SerializablePersistentSession> readSession(
 	}
 
 	private File getSessionFile(String deploymentName) {
-		if (!this.folder.exists()) {
-			this.folder.mkdirs();
+		if (!this.dir.exists()) {
+			this.dir.mkdirs();
 		}
-		return new File(this.folder, deploymentName + ".session");
+		return new File(this.dir, deploymentName + ".session");
 	}
 
 	@Override
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainer.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainer.java
@@ -113,7 +113,7 @@ public synchronized void start() throws EmbeddedServletContainerException {
 		}
 		catch (ServletException ex) {
 			throw new EmbeddedServletContainerException(
-					"Unable to start embdedded Undertow", ex);
+					"Unable to start embedded Undertow", ex);
 		}
 	}
 
diff --git a/spring-boot/src/main/java/org/springframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainerFactory.java b/spring-boot/src/main/java/org/springframework/boot/context/embedded/undertow/UndertowEmbeddedServletContainerFactory.java
@@ -358,8 +358,8 @@ private DeploymentManager createDeploymentManager(
 			configureAccessLog(deployment);
 		}
 		if (isPersistSession()) {
-			File folder = getValidSessionStoreDir();
-			deployment.setSessionPersistenceManager(new FileSessionPersistence(folder));
+			File dir = getValidSessionStoreDir();
+			deployment.setSessionPersistenceManager(new FileSessionPersistence(dir));
 		}
 		DeploymentManager manager = Servlets.defaultContainer().addDeployment(deployment);
 		manager.deploy();
@@ -433,7 +433,7 @@ private ResourceManager getDocumentRootResourceManager() {
 			return new FileResourceManager(root, 0);
 		}
 		if (root.isFile()) {
-			return new JarResourcemanager(root);
+			return new JarResourceManager(root);
 		}
 		return ResourceManager.EMPTY_RESOURCE_MANAGER;
 	}
@@ -532,15 +532,15 @@ public void setUseForwardHeaders(boolean useForwardHeaders) {
 	/**
 	 * Undertow {@link ResourceManager} for JAR resources.
 	 */
-	private static class JarResourcemanager implements ResourceManager {
+	private static class JarResourceManager implements ResourceManager {
 
 		private final String jarPath;
 
-		JarResourcemanager(File jarFile) {
+		JarResourceManager(File jarFile) {
 			this(jarFile.getAbsolutePath());
 		}
 
-		JarResourcemanager(String jarPath) {
+		JarResourceManager(String jarPath) {
 			this.jarPath = jarPath;
 		}
 
diff --git a/spring-boot/src/main/java/org/springframework/boot/test/SpringBootMockServletContext.java b/spring-boot/src/main/java/org/springframework/boot/test/SpringBootMockServletContext.java
@@ -28,7 +28,7 @@
 
 /**
  * {@link MockServletContext} implementation for Spring Boot. Respects well know Spring
- * Boot resource locations and uses an empty folder for "/" if no locations can be found.
+ * Boot resource locations and uses an empty directory for "/" if no locations can be found.
  *
  * @author Phillip Webb
  */
@@ -88,7 +88,7 @@ private boolean exists(String resourceLocation) {
 	public URL getResource(String path) throws MalformedURLException {
 		URL resource = super.getResource(path);
 		if (resource == null && "/".equals(path)) {
-			// Liquibase assumes that "/" always exists, if we don't have a folder
+			// Liquibase assumes that "/" always exists, if we don't have a directory
 			// use a temporary location.
 			try {
 				if (this.emptyRootFolder == null) {
diff --git a/spring-boot/src/test/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactoryTests.java b/spring-boot/src/test/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactoryTests.java
@@ -342,7 +342,7 @@ public void useForwardHeaders() throws Exception {
 	public void disableDoesNotSaveSessionFiles() throws Exception {
 		File baseDir = this.temporaryFolder.newFolder();
 		TomcatEmbeddedServletContainerFactory factory = getFactory();
-		// If baseDir is not set SESSIONS.ser is written to a different temp folder
+		// If baseDir is not set SESSIONS.ser is written to a different temp directory
 		// each time. By setting it we can really ensure that data isn't saved
 		factory.setBaseDirectory(baseDir);
 		this.container = factory
diff --git a/spring-boot/src/test/java/org/springframework/boot/context/embedded/undertow/FileSessionPersistenceTests.java b/spring-boot/src/test/java/org/springframework/boot/context/embedded/undertow/FileSessionPersistenceTests.java
@@ -43,7 +43,7 @@ public class FileSessionPersistenceTests {
 	@Rule
 	public TemporaryFolder temp = new TemporaryFolder();
 
-	private File folder;
+	private File dir;
 
 	private FileSessionPersistence persistence;
 
@@ -53,8 +53,8 @@ public class FileSessionPersistenceTests {
 
 	@Before
 	public void setup() throws IOException {
-		this.folder = this.temp.newFolder();
-		this.persistence = new FileSessionPersistence(this.folder);
+		this.dir = this.temp.newFolder();
+		this.persistence = new FileSessionPersistence(this.dir);
 	}
 
 	@Test
@@ -97,7 +97,7 @@ public void dontRestoreExpired() throws Exception {
 
 	@Test
 	public void deleteFileOnClear() throws Exception {
-		File sessionFile = new File(this.folder, "test.session");
+		File sessionFile = new File(this.dir, "test.session");
 		Map<String, PersistentSession> sessionData = new LinkedHashMap<String, PersistentSession>();
 		this.persistence.persistSessions("test", sessionData);
 		assertThat(sessionFile.exists(), equalTo(true));

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* Simple detection for well known cloud platforms. For more advanced cloud provider`
`23`		`- * integration consider the Spring Clould project.`
	`23`	`+ * integration consider the Spring Cloud project.`
`24`	`24`	`*`
`25`	`25`	`* @author Phillip Webb`
`26`	`26`	`* @since 1.3.0`
Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@ protected final ServletContextInitializer[] mergeInitializers(`
`331`	`331`	`}`
`332`	`332`
`333`	`333`	`/**`
`334`		`- * Returns whether or not he JSP servlet should be registered with the embedded`
	`334`	`+ * Returns whether or not the JSP servlet should be registered with the embedded`
`335`	`335`	`* container.`
`336`	`336`	`* @return {@code true} if the container should be registered, otherwise {@code false}`
`337`	`337`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ private static class Tomcat7Resources extends TomcatResources {`
`116`	`116`
`117`	`117`	`@Override`
`118`	`118`	`protected void addJar(String jar) {`
`119`		`- URL url = getJarUlr(jar);`
	`119`	`+ URL url = getJarUrl(jar);`
`120`	`120`	`if (url != null) {`
`121`	`121`	`try {`
`122`	`122`	`this.addResourceJarUrlMethod.invoke(getContext(), url);`
`@@ -127,7 +127,7 @@ protected void addJar(String jar) {`
`127`	`127`	`}`
`128`	`128`	`}`
`129`	`129`
`130`		`- private URL getJarUlr(String jar) {`
	`130`	`+ private URL getJarUrl(String jar) {`
`131`	`131`	`try {`
`132`	`132`	`return new URL(jar);`
`133`	`133`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,10 @@`
`38`	`38`	`*/`
`39`	`39`	`public class FileSessionPersistence implements SessionPersistenceManager {`
`40`	`40`
`41`		`- private final File folder;`
	`41`	`+ private final File dir;`
`42`	`42`
`43`		`- public FileSessionPersistence(File folder) {`
`44`		`- this.folder = folder;`
	`43`	`+ public FileSessionPersistence(File dir) {`
	`44`	`+ this.dir = dir;`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`
`@@ -124,10 +124,10 @@ private Map<String, SerializablePersistentSession> readSession(`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`private File getSessionFile(String deploymentName) {`
`127`		`- if (!this.folder.exists()) {`
`128`		`- this.folder.mkdirs();`
	`127`	`+ if (!this.dir.exists()) {`
	`128`	`+ this.dir.mkdirs();`
`129`	`129`	`}`
`130`		`- return new File(this.folder, deploymentName + ".session");`
	`130`	`+ return new File(this.dir, deploymentName + ".session");`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ public synchronized void start() throws EmbeddedServletContainerException {`
`113`	`113`	`}`
`114`	`114`	`catch (ServletException ex) {`
`115`	`115`	`throw new EmbeddedServletContainerException(`
`116`		`- "Unable to start embdedded Undertow", ex);`
	`116`	`+ "Unable to start embedded Undertow", ex);`
`117`	`117`	`}`
`118`	`118`	`}`
`119`	`119`
Original file line number	Diff line number	Diff line change
`@@ -358,8 +358,8 @@ private DeploymentManager createDeploymentManager(`
`358`	`358`	`configureAccessLog(deployment);`
`359`	`359`	`}`
`360`	`360`	`if (isPersistSession()) {`
`361`		`- File folder = getValidSessionStoreDir();`
`362`		`- deployment.setSessionPersistenceManager(new FileSessionPersistence(folder));`
	`361`	`+ File dir = getValidSessionStoreDir();`
	`362`	`+ deployment.setSessionPersistenceManager(new FileSessionPersistence(dir));`
`363`	`363`	`}`
`364`	`364`	`DeploymentManager manager = Servlets.defaultContainer().addDeployment(deployment);`
`365`	`365`	`manager.deploy();`
`@@ -433,7 +433,7 @@ private ResourceManager getDocumentRootResourceManager() {`
`433`	`433`	`return new FileResourceManager(root, 0);`
`434`	`434`	`}`
`435`	`435`	`if (root.isFile()) {`
`436`		`- return new JarResourcemanager(root);`
	`436`	`+ return new JarResourceManager(root);`
`437`	`437`	`}`
`438`	`438`	`return ResourceManager.EMPTY_RESOURCE_MANAGER;`
`439`	`439`	`}`
`@@ -532,15 +532,15 @@ public void setUseForwardHeaders(boolean useForwardHeaders) {`
`532`	`532`	`/**`
`533`	`533`	`* Undertow {@link ResourceManager} for JAR resources.`
`534`	`534`	`*/`
`535`		`- private static class JarResourcemanager implements ResourceManager {`
	`535`	`+ private static class JarResourceManager implements ResourceManager {`
`536`	`536`
`537`	`537`	`private final String jarPath;`
`538`	`538`
`539`		`- JarResourcemanager(File jarFile) {`
	`539`	`+ JarResourceManager(File jarFile) {`
`540`	`540`	`this(jarFile.getAbsolutePath());`
`541`	`541`	`}`
`542`	`542`
`543`		`- JarResourcemanager(String jarPath) {`
	`543`	`+ JarResourceManager(String jarPath) {`
`544`	`544`	`this.jarPath = jarPath;`
`545`	`545`	`}`
`546`	`546`