root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Polish AbstractContextLoaderInitializer and subclasses 

This commit polishes the Javadoc and assertion failure messages for
AbstractContextLoaderInitializer and its subclasses.
This commit is contained in:
Sam Brannen 2013-08-05 19:13:16 +02:00
parent cb77440936
commit cc2e7bb3d7
3 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spring-web/src/main/java/org/springframework/web/context/AbstractContextLoaderInitializer.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2013 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -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}. * {@code ContextLoaderListener}.
* <p>The returned context is delegated to * <p>The returned context is delegated to
* {@link ContextLoaderListener#ContextLoaderListener(WebApplicationContext)} and will * {@link ContextLoaderListener#ContextLoaderListener(WebApplicationContext)} and will

6
spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractAnnotationConfigDispatcherServletInitializer.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2013 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -28,8 +28,8 @@ import org.springframework.web.context.support.AnnotationConfigWebApplicationCon
* configured with annotated classes, e.g. Spring's {@link * configured with annotated classes, e.g. Spring's {@link
* org.springframework.context.annotation.Configuration @Configuration} classes. * org.springframework.context.annotation.Configuration @Configuration} classes.
* *
* <p>Concrete implementations are required to implement {@link #getRootConfigClasses()}, * <p>Concrete implementations are required to implement {@link #getRootConfigClasses()}
* {@link #getServletConfigClasses()}, as well as {@link #getServletMappings()}. Further * and {@link #getServletConfigClasses()} as well as {@link #getServletMappings()}. Further
* template and customization methods are provided by {@link * template and customization methods are provided by {@link
* AbstractDispatcherServletInitializer}. * AbstractDispatcherServletInitializer}.
* *

22
spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java
View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2013 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -40,7 +40,7 @@ import org.springframework.web.servlet.DispatcherServlet;
* *
* <p>Concrete implementations are required to implement {@link * <p>Concrete implementations are required to implement {@link
* #createServletApplicationContext()}, as well as {@link #getServletMappings()}, both of * #createServletApplicationContext()}, as well as {@link #getServletMappings()}, both of
* which gets invoked from {@link #registerDispatcherServlet(ServletContext)}. Further * which get invoked from {@link #registerDispatcherServlet(ServletContext)}. Further
* customization can be achieved by overriding * customization can be achieved by overriding
* {@link #customizeRegistration(ServletRegistration.Dynamic)}. * {@link #customizeRegistration(ServletRegistration.Dynamic)}.
* *
@ -72,7 +72,7 @@ public abstract class AbstractDispatcherServletInitializer
/** /**
* Register a {@link DispatcherServlet} against the given servlet context. * Register a {@link DispatcherServlet} against the given servlet context.
* <p>This method will create a {@code DispatcherServlet} with the name returned by * <p>This method will create a {@code DispatcherServlet} with the name returned from
* {@link #getServletName()}, initializing it with the application context returned * {@link #getServletName()}, initializing it with the application context returned
* from {@link #createServletApplicationContext()}, and mapping it to the patterns * from {@link #createServletApplicationContext()}, and mapping it to the patterns
* returned from {@link #getServletMappings()}. * returned from {@link #getServletMappings()}.
@ -82,8 +82,7 @@ public abstract class AbstractDispatcherServletInitializer
*/ */
protected void registerDispatcherServlet(ServletContext servletContext) { protected void registerDispatcherServlet(ServletContext servletContext) {
String servletName = this.getServletName(); String servletName = this.getServletName();
Assert.hasLength(servletName, Assert.hasLength(servletName, "getServletName() may not return empty or null");
"getServletName() may not return empty or null");
WebApplicationContext servletAppContext = this.createServletApplicationContext(); WebApplicationContext servletAppContext = this.createServletApplicationContext();
Assert.notNull(servletAppContext, Assert.notNull(servletAppContext,
@ -96,7 +95,7 @@ public abstract class AbstractDispatcherServletInitializer
servletContext.addServlet(servletName, dispatcherServlet); servletContext.addServlet(servletName, dispatcherServlet);
Assert.notNull(registration, Assert.notNull(registration,
"Failed to register servlet with name '" + servletName + "'." + "Failed to register servlet with name '" + servletName + "'. " +
"Check if there is another servlet registered under the same name."); "Check if there is another servlet registered under the same name.");
registration.setLoadOnStartup(1); registration.setLoadOnStartup(1);
@ -125,7 +124,7 @@ public abstract class AbstractDispatcherServletInitializer
/** /**
* Create a servlet application context to be provided to the {@code DispatcherServlet}. * Create a servlet application context to be provided to the {@code DispatcherServlet}.
* <p>The returned context is delegated to Spring's * <p>The returned context is delegated to Spring's
* {@link DispatcherServlet#DispatcherServlet(WebApplicationContext)} As such, it * {@link DispatcherServlet#DispatcherServlet(WebApplicationContext)}. As such, it
* typically contains controllers, view resolvers, locale resolvers, and other * typically contains controllers, view resolvers, locale resolvers, and other
* web-related beans. * web-related beans.
* @see #registerDispatcherServlet(ServletContext) * @see #registerDispatcherServlet(ServletContext)
@ -133,13 +132,14 @@ public abstract class AbstractDispatcherServletInitializer
protected abstract WebApplicationContext createServletApplicationContext(); 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) * @see #registerDispatcherServlet(ServletContext)
*/ */
protected abstract String[] getServletMappings(); 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} * @return an array of filters or {@code null}
* @see #registerServletFilter(ServletContext, Filter) * @see #registerServletFilter(ServletContext, Filter)
@ -159,8 +159,8 @@ public abstract class AbstractDispatcherServletInitializer
* {@code FORWARD}, {@code INCLUDE}, and conditionally {@code ASYNC} depending * {@code FORWARD}, {@code INCLUDE}, and conditionally {@code ASYNC} depending
* on the return value of {@link #isAsyncSupported() asyncSupported} * on the return value of {@link #isAsyncSupported() asyncSupported}
* </ul> * </ul>
* <p>If the above defaults are not suitable or insufficient, register * <p>If the above defaults are not suitable or insufficient, override this
* filters directly with the {@code ServletContext}. * method and register filters directly with the {@code ServletContext}.
* *
* @param servletContext the servlet context to register filters with * @param servletContext the servlet context to register filters with
* @param filter the filter to be registered * @param filter the filter to be registered