Polishing

Author: jhoeller

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -22,22 +22,30 @@
 import org.springframework.http.HttpMethod;
 
 /**
- * Wrapper for a {@link ClientHttpRequestFactory} that buffers all outgoing and incoming streams in memory.
+ * Wrapper for a {@link ClientHttpRequestFactory} that buffers
+ * all outgoing and incoming streams in memory.
  *
- * <p>Using this wrapper allows for multiple reads of the {@linkplain ClientHttpResponse#getBody() response body}.
+ * <p>Using this wrapper allows for multiple reads of the
+ * @linkplain ClientHttpResponse#getBody() response body}.
  *
  * @author Arjen Poutsma
  * @since 3.1
  */
 public class BufferingClientHttpRequestFactory extends AbstractClientHttpRequestFactoryWrapper {
 
+	/**
+	 * Create a buffering wrapper for the given {@link ClientHttpRequestFactory}.
+	 * @param requestFactory the target request factory to wrap
+	 */
 	public BufferingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory) {
 		super(requestFactory);
 	}
 
+
 	@Override
 	protected ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod, ClientHttpRequestFactory requestFactory)
 			throws IOException {
+
 		ClientHttpRequest request = requestFactory.createRequest(uri, httpMethod);
 		if (shouldBuffer(uri, httpMethod)) {
 			return new BufferingClientHttpRequestWrapper(request);
@@ -48,16 +56,16 @@ protected ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod, Client
 	}
 
 	/**
-	 * Indicates whether the request/response exchange for the given URI and method should be buffered in memory.
-	 *
-	 * <p>Default implementation returns {@code true} for all URIs and methods. Subclasses can override this method to
-	 * change this behavior.
-	 *
+	 * Indicates whether the request/response exchange for the given URI and method
+	 * should be buffered in memory.
+	 * <p>The default implementation returns {@code true} for all URIs and methods.
+	 * Subclasses can override this method to change this behavior.
 	 * @param uri the URI
 	 * @param httpMethod the method
 	 * @return {@code true} if the exchange should be buffered; {@code false} otherwise
 	 */
 	protected boolean shouldBuffer(URI uri, HttpMethod httpMethod) {
 		return true;
 	}
+
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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,7 +21,6 @@
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
-import org.springframework.util.Assert;
 import org.springframework.util.StreamUtils;
 
 /**
@@ -36,7 +35,6 @@ final class BufferingClientHttpRequestWrapper extends AbstractBufferingClientHtt
 
 
 	BufferingClientHttpRequestWrapper(ClientHttpRequest request) {
-		Assert.notNull(request, "'request' must not be null");
 		this.request = request;
 	}
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -25,8 +25,8 @@
 import org.springframework.util.StreamUtils;
 
 /**
- * Simple implementation of {@link ClientHttpResponse} that reads the response's body into memory,
- * thus allowing for multiple invocations of {@link #getBody()}.
+ * Simple implementation of {@link ClientHttpResponse} that reads the response's body
+ * into memory, thus allowing for multiple invocations of {@link #getBody()}.
  *
  * @author Arjen Poutsma
  * @since 3.1

spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java

@@ -40,8 +40,8 @@
  * details see the note on the new support classes added in Spring MVC 3.1
  * further below.
  *
- * <p>Handler methods which are annotated with this annotation are allowed
- * to have very flexible signatures. They may have arguments of the following
+ * <p>Handler methods which are annotated with this annotation are allowed to
+ * have very flexible signatures. They may have parameters of the following
  * types, in arbitrary order (except for validation results, which need to
  * follow right after the corresponding command object, if desired):
  * <ul>
@@ -163,7 +163,7 @@
  * context path, and the literal part of the servlet mapping.
  * </ul>
  *
- * <p><strong>Note:</strong> JDK 1.8's {@code java.util.Optional} is supported
+ * <p><strong>Note:</strong> Java 8's {@code java.util.Optional} is supported
  * as a method parameter type with annotations that provide a {@code required}
  * attribute (e.g. {@code @RequestParam}, {@code @RequestHeader}, etc.). The use
  * of {@code java.util.Optional} in those cases is equivalent to having
@@ -174,8 +174,8 @@
  * <li>A {@code ModelAndView} object (Servlet MVC or Portlet MVC),
  * with the model implicitly enriched with command objects and the results
  * of {@link ModelAttribute @ModelAttribute} annotated reference data accessor methods.
- * <li>A {@link org.springframework.ui.Model Model} object, with the view name
- * implicitly determined through a {@link org.springframework.web.servlet.RequestToViewNameTranslator}
+ * <li>A {@link org.springframework.ui.Model Model} object, with the view name implicitly
+ * determined through a {@link org.springframework.web.servlet.RequestToViewNameTranslator}
  * and the model implicitly enriched with command objects and the results
  * of {@link ModelAttribute @ModelAttribute} annotated reference data accessor methods.
  * <li>A {@link java.util.Map} object for exposing a model,

spring-webmvc/src/main/java/org/springframework/web/servlet/view/json/MappingJackson2JsonView.java

@@ -143,10 +143,11 @@ public final Set<String> getModelKeys() {
 	}
 
 	/**
-	 * Set whether to serialize models containing a single attribute as a map or whether to
-	 * extract the single value from the model and serialize it directly.
-	 * <p>The effect of setting this flag is similar to using {@code MappingJackson2HttpMessageConverter}
-	 * with an {@code @ResponseBody} request-handling method.
+	 * Set whether to serialize models containing a single attribute as a map or
+	 * whether to extract the single value from the model and serialize it directly.
+	 * <p>The effect of setting this flag is similar to using
+	 * {@code MappingJackson2HttpMessageConverter} with an {@code @ResponseBody}
+	 * request-handling method.
 	 * <p>Default is {@code false}.
 	 */
 	public void setExtractValueFromSingleKeyModel(boolean extractValueFromSingleKeyModel) {
@@ -181,7 +182,7 @@ private String getJsonpParameterValue(HttpServletRequest request) {
 	 * Filter out undesired attributes from the given model.
 	 * The return value can be either another {@link Map} or a single value object.
 	 * <p>The default implementation removes {@link BindingResult} instances and entries
-	 * not included in the {@link #setRenderedAttributes renderedAttributes} property.
+	 * not included in the {@link #setModelKeys renderedAttributes} property.
 	 * @param model the model, as passed on to {@link #renderMergedOutputModel}
 	 * @return the value to be rendered
 	 */
@@ -221,9 +222,10 @@ protected void writePrefix(JsonGenerator generator, Object object) throws IOExce
 		if (this.jsonPrefix != null) {
 			generator.writeRaw(this.jsonPrefix);
 		}
+
 		String jsonpFunction = null;
 		if (object instanceof MappingJacksonValue) {
-			jsonpFunction = ((MappingJacksonValue)object).getJsonpFunction();
+			jsonpFunction = ((MappingJacksonValue) object).getJsonpFunction();
 		}
 		if (jsonpFunction != null) {
 			generator.writeRaw(jsonpFunction + "(" );
@@ -234,7 +236,7 @@ protected void writePrefix(JsonGenerator generator, Object object) throws IOExce
 	protected void writeSuffix(JsonGenerator generator, Object object) throws IOException {
 		String jsonpFunction = null;
 		if (object instanceof MappingJacksonValue) {
-			jsonpFunction = ((MappingJacksonValue)object).getJsonpFunction();
+			jsonpFunction = ((MappingJacksonValue) object).getJsonpFunction();
 		}
 		if (jsonpFunction != null) {
 			generator.writeRaw(");");

src/asciidoc/web-mvc.adoc

@@ -635,8 +635,8 @@ controller. When this is the case, for controllers specifically, we recommend
 using class-based proxying. This is typically the default choice with controllers.
 However if a controller must implement an interface that is not a Spring Context
 callback (e.g. `InitializingBean`, `*Aware`, etc), you may need to explicitly
-configure class-based proxying. For example with `<tx:annotation-driven />`,
-change to `<tx:annotation-driven proxy-target-class="true" />`.
+configure class-based proxying. For example with `<tx:annotation-driven/>`,
+change to `<tx:annotation-driven proxy-target-class="true"/>`.
 
 [[mvc-ann-requestmapping-31-vs-30]]
 ==== New Support Classes for @RequestMapping methods in Spring MVC 3.1
@@ -1368,8 +1368,8 @@ the MVC namespace or the MVC Java config see <<mvc-config-enable>> instead.
 
 	<bean id="marshallingHttpMessageConverter"
 			class="org.springframework.http.converter.xml.MarshallingHttpMessageConverter">
-		<property name="marshaller" ref="castorMarshaller" />
-		<property name="unmarshaller" ref="castorMarshaller" />
+		<property name="marshaller" ref="castorMarshaller"/>
+		<property name="unmarshaller" ref="castorMarshaller"/>
 	</bean>
 
 	<bean id="castorMarshaller" class="org.springframework.oxm.castor.CastorMarshaller"/>
@@ -1897,9 +1897,9 @@ PropertyEditors required by several of the PetClinic controllers.
 [subs="verbatim,quotes"]
 ----
 	<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
-		<property name="cacheSeconds" value="0" />
+		<property name="cacheSeconds" value="0"/>
 		<property name="webBindingInitializer">
-			<bean class="org.springframework.samples.petclinic.web.ClinicBindingInitializer" />
+			<bean class="org.springframework.samples.petclinic.web.ClinicBindingInitializer"/>
 		</property>
 	</bean>
 ----
@@ -4512,7 +4512,7 @@ context defined):
 			http://www.springframework.org/schema/mvc
 			http://www.springframework.org/schema/mvc/spring-mvc.xsd">
 
-		<mvc:annotation-driven />
+		<mvc:annotation-driven/>
 
 	</beans>
 ----
@@ -4602,7 +4602,7 @@ and override the methods you need:
 	}
 ----
 
-To customize the default configuration of `<mvc:annotation-driven />` check what
+To customize the default configuration of `<mvc:annotation-driven/>` check what
 attributes and sub-elements it supports. You can view the
 http://schema.spring.io/mvc/spring-mvc.xsd[Spring MVC XML schema] or use the code
 completion feature of your IDE to discover what attributes and sub-elements are
@@ -4799,15 +4799,15 @@ And in XML use the `<mvc:interceptors>` element:
 [subs="verbatim"]
 ----
 	<mvc:interceptors>
-		<bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor" />
+		<bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"/>
 		<mvc:interceptor>
 			<mvc:mapping path="/**"/>
 			<mvc:exclude-mapping path="/admin/**"/>
-			<bean class="org.springframework.web.servlet.theme.ThemeChangeInterceptor" />
+			<bean class="org.springframework.web.servlet.theme.ThemeChangeInterceptor"/>
 		</mvc:interceptor>
 		<mvc:interceptor>
 			<mvc:mapping path="/secure/*"/>
-			<bean class="org.example.SecurityInterceptor" />
+			<bean class="org.example.SecurityInterceptor"/>
 		</mvc:interceptor>
 	</mvc:interceptors>
 ----
@@ -4858,7 +4858,7 @@ that in turn can be created with a `ContentNegotiationManagerFactoryBean`:
 [source,xml,indent=0]
 [subs="verbatim,quotes"]
 ----
-	<mvc:annotation-driven content-negotiation-manager="contentNegotiationManager" />
+	<mvc:annotation-driven content-negotiation-manager="contentNegotiationManager"/>
 
 	<bean id="contentNegotiationManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
 		<property name="favorPathExtension" value="false"/>
@@ -4954,10 +4954,10 @@ And the same in XML:
 	<mvc:view-resolvers>
 		<mvc:content-negotiation>
 			<mvc:default-views>
-				<bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView" />
+				<bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"/>
 			</mvc:default-views>
 		</mvc:content-negotiation>
-		<mvc:jsp />
+		<mvc:jsp/>
 	</mvc:view-resolvers>
 ----
 
@@ -4973,14 +4973,14 @@ The MVC namespace provides dedicated elements. For example with FreeMarker:
 	<mvc:view-resolvers>
 		<mvc:content-negotiation>
 			<mvc:default-views>
-				<bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView" />
+				<bean class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"/>
 			</mvc:default-views>
 		</mvc:content-negotiation>
-		<mvc:freemarker cache="false" />
+		<mvc:freemarker cache="false"/>
 	</mvc:view-resolvers>
 
 	<mvc:freemarker-configurer>
-		<mvc:template-loader-path location="/freemarker" />
+		<mvc:template-loader-path location="/freemarker"/>
 	</mvc:freemarker-configurer>
 
 ----
@@ -5158,7 +5158,7 @@ XML example:
 ----
 <mvc:resources mapping="/resources/**" location="/public-resources/">
 	<mvc:resource-chain>
-		<mvc:resource-cache />
+		<mvc:resource-cache/>
 		<mvc:resolvers>
 			<mvc:version-resolver>
 				<mvc:content-version-strategy patterns="/**"/>
@@ -5306,11 +5306,11 @@ And the same in XML, use the `<mvc:path-matching>` element:
             trailing-slash="false"
             registered-suffixes-only="true"
             path-helper="pathHelper"
-            path-matcher="pathMatcher" />
+            path-matcher="pathMatcher"/>
     </mvc:annotation-driven>
 
-    <bean id="pathHelper" class="org.example.app.MyPathHelper" />
-    <bean id="pathMatcher" class="org.example.app.MyPathMatcher" />
+    <bean id="pathHelper" class="org.example.app.MyPathHelper"/>
+    <bean id="pathMatcher" class="org.example.app.MyPathMatcher"/>
 ----
 
 
@@ -5373,20 +5373,20 @@ It is also possible to do the same in XML:
     <mvc:annotation-driven>
         <mvc:message-converters>
             <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
-                <property name="objectMapper" ref="objectMapper" />
+                <property name="objectMapper" ref="objectMapper"/>
             </bean>
             <bean class="org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter">
-                <property name="objectMapper" ref="xmlMapper" />
+                <property name="objectMapper" ref="xmlMapper"/>
             </bean>
         </mvc:message-converters>
     </mvc:annotation-driven>
 
     <bean id="objectMapper" class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean"
           p:indentOutput="true"
           p:simpleDateFormat="yyyy-MM-dd"
-          p:modulesToInstall="com.fasterxml.jackson.module.paramnames.ParameterNamesModule" />
+          p:modulesToInstall="com.fasterxml.jackson.module.paramnames.ParameterNamesModule"/>
 
-    <bean id="xmlMapper" parent="objectMapper" p:createXmlMapper="true" />
+    <bean id="xmlMapper" parent="objectMapper" p:createXmlMapper="true"/>
 ----
 
 
@@ -5470,6 +5470,6 @@ by type and then modifying its properties as necessary. For example:
 	}
 ----
 
-Note that `MyPostProcessor` needs to be included in an `<component scan />` in order for
+Note that `MyPostProcessor` needs to be included in an `<component scan/>` in order for
 it to be detected or if you prefer you can declare it explicitly with an XML bean
 declaration.