Clarified ServletConfigAware behavior in case of no ServletConfig being available

jhoeller · jhoeller · commit 03c3dc3daed8 · 2012-10-31T09:02:48.000+01:00
Issue: SPR-9855
diff --git a/org.springframework.web/src/main/java/org/springframework/web/context/ServletConfigAware.java b/org.springframework.web/src/main/java/org/springframework/web/context/ServletConfigAware.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 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,13 +21,12 @@
 import org.springframework.beans.factory.Aware;
 
 /**
- * Interface to be implemented by any object that wishes to be notified
- * of the ServletConfig (typically determined by the WebApplicationContext)
+ * Interface to be implemented by any object that wishes to be notified of the
+ * {@link ServletConfig} (typically determined by the {@link WebApplicationContext})
  * that it runs in.
  *
- * <p>Only satisfied if actually running within a Servlet-specific
- * WebApplicationContext. If this callback interface is encountered
- * elsewhere, an exception will be thrown on bean creation.
+ * <p>Note: Only satisfied if actually running within a Servlet-specific
+ * WebApplicationContext. Otherwise, no ServletConfig will be set.
  *
  * @author Juergen Hoeller
  * @author Chris Beams
@@ -37,7 +36,7 @@
 public interface ServletConfigAware extends Aware {
 
 	/**
-	 * Set the ServletConfig that this object runs in.
+	 * Set the {@link ServletConfig} that this object runs in.
 	 * <p>Invoked after population of normal bean properties but before an init
 	 * callback like InitializingBean's <code>afterPropertiesSet</code> or a
 	 * custom init-method. Invoked after ApplicationContextAware's
diff --git a/org.springframework.web/src/main/java/org/springframework/web/context/ServletContextAware.java b/org.springframework.web/src/main/java/org/springframework/web/context/ServletContextAware.java
@@ -1,12 +1,12 @@
 /*
- * Copyright 2002-2011 the original author or authors.
- * 
+ * Copyright 2002-2012 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.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -21,8 +21,8 @@
 import org.springframework.beans.factory.Aware;
 
 /**
- * Interface to be implemented by any object that wishes to be notified
- * of the ServletContext (typically determined by the WebApplicationContext)
+ * Interface to be implemented by any object that wishes to be notified of the
+ * {@link ServletContext} (typically determined by the {@link WebApplicationContext})
  * that it runs in.
  *
  * @author Juergen Hoeller
@@ -33,7 +33,7 @@
 public interface ServletContextAware extends Aware {
 
 	/**
-	 * Set the ServletContext that this object runs in.
+	 * Set the {@link ServletContext} that this object runs in.
 	 * <p>Invoked after population of normal bean properties but before an init
 	 * callback like InitializingBean's <code>afterPropertiesSet</code> or a
 	 * custom init-method. Invoked after ApplicationContextAware's
