Polishing

Issue: SPR-11357
2014-01-24 19:19:32 +01:00
parent 87179b075b
commit 5307a87d1a
4 changed files with 34 additions and 35 deletions
--- a/spring-web/src/main/java/org/springframework/web/context/AbstractContextLoaderInitializer.java
+++ b/spring-web/src/main/java/org/springframework/web/context/AbstractContextLoaderInitializer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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,12 +25,12 @@ import org.apache.commons.logging.LogFactory;
 import org.springframework.web.WebApplicationInitializer;

 /**
- * Convenient base class for {@link WebApplicationInitializer} implementations that
- * register a {@link ContextLoaderListener} in the servlet context.
+ * Convenient base class for {@link WebApplicationInitializer} implementations
+ * that register a {@link ContextLoaderListener} in the servlet context.
 *
- * <p>The only method required to be implemented by subclasses is {@link
- * #createRootApplicationContext()}, which gets invoked from {@link
- * #registerContextLoaderListener(javax.servlet.ServletContext)}.
+ * <p>The only method required to be implemented by subclasses is
+ * {@link #createRootApplicationContext()}, which gets invoked from
+ * {@link #registerContextLoaderListener(ServletContext)}.
 *
 * @author Arjen Poutsma
 * @author Chris Beams
@@ -64,7 +64,7 @@ public abstract class AbstractContextLoaderInitializer implements WebApplication
 	}

 	/**
-	 * Create the "root" application context to be provided to the
+	 * Create the "<strong>root</strong>" application context to be provided to the
 	 * {@code ContextLoaderListener}.
 	 * <p>The returned context is delegated to
 	 * {@link ContextLoaderListener#ContextLoaderListener(WebApplicationContext)} and will
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java
@@ -21,16 +21,16 @@ import org.springframework.web.context.WebApplicationContext;
 import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;

 /**
- * Base class for {@link org.springframework.web.WebApplicationInitializer
- * WebApplicationInitializer} implementations that register a {@link
- * org.springframework.web.servlet.DispatcherServlet DispatcherServlet}
- * configured with annotated classes, e.g. Spring's {@link
- * org.springframework.context.annotation.Configuration @Configuration} classes.
+ * Base class for {@link org.springframework.web.WebApplicationInitializer}
+ * implementations that register a
+ * {@link org.springframework.web.servlet.DispatcherServlet DispatcherServlet}
+ * configured with annotated classes, e.g. Spring's
+ * {@link org.springframework.context.annotation.Configuration @Configuration} classes.
 *
 * <p>Concrete implementations are required to implement {@link #getRootConfigClasses()}
- * and {@link #getServletConfigClasses()} as well as {@link #getServletMappings()}. Further
- * template and customization methods are provided by {@link
- * AbstractDispatcherServletInitializer}.
+ * and {@link #getServletConfigClasses()} as well as {@link #getServletMappings()}.
+ * Further template and customization methods are provided by
+ * {@link AbstractDispatcherServletInitializer}.
 *
 * @author Arjen Poutsma
 * @author Chris Beams
@@ -88,7 +88,7 @@ public abstract class AbstractAnnotationConfigDispatcherServletInitializer
 	 * provided to the {@linkplain #createServletApplicationContext() dispatcher servlet
 	 * application context}.
 	 * @return the configuration classes for the dispatcher servlet application context
-	 * (may not be empty or {@code null}).
+	 * (may not be empty or {@code null})
 	 */
 	protected abstract Class<?>[] getServletConfigClasses();

--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -33,14 +33,13 @@ import org.springframework.web.context.WebApplicationContext;
 import org.springframework.web.servlet.DispatcherServlet;

 /**
- * Base class for {@link org.springframework.web.WebApplicationInitializer
- * WebApplicationInitializer} implementations that register a {@link DispatcherServlet} in
- * the servlet context.
+ * Base class for {@link org.springframework.web.WebApplicationInitializer}
+ * implementations that register a {@link DispatcherServlet} in the servlet context.
 *
- * <p>Concrete implementations are required to implement {@link
- * #createServletApplicationContext()}, as well as {@link #getServletMappings()}, both of
- * which gets invoked from {@link #registerDispatcherServlet(ServletContext)}. Further
- * customization can be achieved by overriding
+ * <p>Concrete implementations are required to implement
+ * {@link #createServletApplicationContext()}, as well as {@link #getServletMappings()},
+ * both of which get invoked from {@link #registerDispatcherServlet(ServletContext)}.
+ * Further customization can be achieved by overriding
 * {@link #customizeRegistration(ServletRegistration.Dynamic)}.
 *
 * <p>Because this class extends from {@link AbstractContextLoaderInitializer}, concrete
@@ -80,10 +79,10 @@ public abstract class AbstractDispatcherServletInitializer extends AbstractConte
 	 * @param servletContext the context to register the servlet against
 	 */
 	protected void registerDispatcherServlet(ServletContext servletContext) {
-		String servletName = this.getServletName();
+		String servletName = getServletName();
 		Assert.hasLength(servletName, "getServletName() may not return empty or null");

-		WebApplicationContext servletAppContext = this.createServletApplicationContext();
+		WebApplicationContext servletAppContext = createServletApplicationContext();
 		Assert.notNull(servletAppContext,
 				"createServletApplicationContext() did not return an application " +
 				"context for servlet [" + servletName + "]");
@@ -105,7 +104,7 @@ public abstract class AbstractDispatcherServletInitializer extends AbstractConte
 			}
 		}

-		this.customizeRegistration(registration);
+		customizeRegistration(registration);
 	}

 	/**
@@ -120,22 +119,22 @@ public abstract class AbstractDispatcherServletInitializer extends AbstractConte
 	/**
 	 * Create a servlet application context to be provided to the {@code DispatcherServlet}.
 	 * <p>The returned context is delegated to Spring's
-	 * {@link DispatcherServlet#DispatcherServlet(WebApplicationContext)} As such, it
-	 * typically contains controllers, view resolvers, locale resolvers, and other
+	 * {@link DispatcherServlet#DispatcherServlet(WebApplicationContext)}. As such,
+	 * it typically contains controllers, view resolvers, locale resolvers, and other
 	 * web-related beans.
 	 * @see #registerDispatcherServlet(ServletContext)
 	 */
 	protected abstract WebApplicationContext createServletApplicationContext();

 	/**
-	 * Specify the servlet mapping(s) for the {@code DispatcherServlet}, e.g. '/', '/app', etc.
+	 * Specify the servlet mapping(s) for the {@code DispatcherServlet} &mdash;
+	 * for example {@code "/"}, {@code "/app"}, etc.
 	 * @see #registerDispatcherServlet(ServletContext)
 	 */
 	protected abstract String[] getServletMappings();

 	/**
-	 * Specify filters to add and also map to the {@code DispatcherServlet}.
-	 *
+	 * Specify filters to add and map to the {@code DispatcherServlet}.
 	 * @return an array of filters or {@code null}
 	 * @see #registerServletFilter(ServletContext, Filter)
 	 */
@@ -154,9 +153,8 @@ public abstract class AbstractDispatcherServletInitializer extends AbstractConte
 	 * {@code FORWARD}, {@code INCLUDE}, and conditionally {@code ASYNC} depending
 	 * on the return value of {@link #isAsyncSupported() asyncSupported}
 	 * </ul>
-	 * <p>If the above defaults are not suitable or insufficient, register
-	 * filters directly with the {@code ServletContext}.
-	 *
+	 * <p>If the above defaults are not suitable or insufficient, override this
+	 * method and register filters directly with the {@code ServletContext}.
 	 * @param servletContext the servlet context to register filters with
 	 * @param filter the filter to be registered
 	 * @return the filter registration
--- a/spring-webmvc/src/test/java/org/springframework/web/servlet/support/AnnotationConfigDispatcherServletInitializerTests.java
+++ b/spring-webmvc/src/test/java/org/springframework/web/servlet/support/AnnotationConfigDispatcherServletInitializerTests.java
@@ -179,6 +179,7 @@ public class AnnotationConfigDispatcherServletInitializerTests {

 	private class MyMockServletContext extends MockServletContext {

+		@Override
 		public <T extends EventListener> void addListener(T t) {
 			if (t instanceof ServletContextListener) {
 				((ServletContextListener) t).contextInitialized(new ServletContextEvent(this));