Document default locale in MockHttpServletRequest

sbrannen · sbrannen · commit 9bf73f3ab846 · 2014-07-28T19:07:26.000+03:00
This commit updates the class-level Javadoc for MockHttpServletRequest
with information regarding the default locale for the mocked server.

Issue: SPR-11701
diff --git a/spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java b/spring-test/src/main/java/org/springframework/mock/web/MockHttpServletRequest.java
@@ -58,7 +58,12 @@
 /**
  * Mock implementation of the {@link javax.servlet.http.HttpServletRequest} interface.
  *
- * <p>As of Spring 4.0, this set of mocks is designed on a Servlet 3.0 baseline.
+ * <p>The default, preferred {@link Locale} for the <em>server</em> mocked
+ * by this request is {@link Locale#ENGLISH}. This value can be changed
+ * via {@link #addPreferredLocale} or {@link #setPreferredLocales}.
+ *
+ * <p>As of Spring Framework 4.0, this set of mocks is designed on a Servlet
+ * 3.0 baseline.
  *
  * @author Juergen Hoeller
  * @author Rod Johnson

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,12 @@`
`58`	`58`	`/**`
`59`	`59`	`* Mock implementation of the {@link javax.servlet.http.HttpServletRequest} interface.`
`60`	`60`	`*`
`61`		`- * <p>As of Spring 4.0, this set of mocks is designed on a Servlet 3.0 baseline.`
	`61`	`+ * <p>The default, preferred {@link Locale} for the <em>server</em> mocked`
	`62`	`+ * by this request is {@link Locale#ENGLISH}. This value can be changed`
	`63`	`+ * via {@link #addPreferredLocale} or {@link #setPreferredLocales}.`
	`64`	`+ *`
	`65`	`+ * <p>As of Spring Framework 4.0, this set of mocks is designed on a Servlet`
	`66`	`+ * 3.0 baseline.`
`62`	`67`	`*`
`63`	`68`	`* @author Juergen Hoeller`
`64`	`69`	`* @author Rod Johnson`