leosutic 2003/02/04 01:15:32
Modified: src/java/org/apache/avalon/framework/service
Serviceable.java
src/java/org/apache/avalon/framework/parameters
Parameterizable.java
src/java/org/apache/avalon/framework/logger LogEnabled.java
src/java/org/apache/avalon/framework/context
Contextualizable.java
src/java/org/apache/avalon/framework/component
Composable.java
Log:
Some Javadoc changes. There was some confusion as to whether a
container may pass a null reference to any of the lifecycle methods.
It is now made explicit that it may not do so.
Revision Changes Path
1.14 +1 -1
jakarta-avalon/src/java/org/apache/avalon/framework/service/Serviceable.java
Index: Serviceable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/service/Serviceable.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- Serviceable.java 23 Nov 2002 08:59:00 -0000 1.13
+++ Serviceable.java 4 Feb 2003 09:15:32 -0000 1.14
@@ -81,7 +81,7 @@
* execution.
*
* @param manager The <code>ServiceManager</code> which this
- * <code>Serviceable</code> uses.
+ * <code>Serviceable</code> uses. Must not be <code>null</code>.
* @throws ServiceException if an error occurs
*/
void service( ServiceManager manager )
1.13 +1 -1
jakarta-avalon/src/java/org/apache/avalon/framework/parameters/Parameterizable.java
Index: Parameterizable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/parameters/Parameterizable.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Parameterizable.java 23 Nov 2002 08:59:00 -0000 1.12
+++ Parameterizable.java 4 Feb 2003 09:15:32 -0000 1.13
@@ -78,7 +78,7 @@
/**
* Provide component with parameters.
*
- * @param parameters the parameters
+ * @param parameters the parameters. Must not be <code>null</code>.
* @throws ParameterException if parameters are invalid
*/
void parameterize( Parameters parameters )
1.11 +1 -1
jakarta-avalon/src/java/org/apache/avalon/framework/logger/LogEnabled.java
Index: LogEnabled.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/logger/LogEnabled.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- LogEnabled.java 23 Nov 2002 08:58:59 -0000 1.10
+++ LogEnabled.java 4 Feb 2003 09:15:32 -0000 1.11
@@ -65,7 +65,7 @@
/**
* Provide component with a logger.
*
- * @param logger the logger
+ * @param logger the logger. Must not be <code>null</code>.
*/
void enableLogging( Logger logger );
}
1.10 +1 -1
jakarta-avalon/src/java/org/apache/avalon/framework/context/Contextualizable.java
Index: Contextualizable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/context/Contextualizable.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- Contextualizable.java 23 Nov 2002 08:58:59 -0000 1.9
+++ Contextualizable.java 4 Feb 2003 09:15:32 -0000 1.10
@@ -68,7 +68,7 @@
* This method is called after the Loggable.setLogger() (if present)
* method and before any other method.
*
- * @param context the context
+ * @param context the context. Must not be <code>null</code>.
* @throws ContextException if context is invalid
*/
void contextualize( Context context )
1.16 +1 -1
jakarta-avalon/src/java/org/apache/avalon/framework/component/Composable.java
Index: Composable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/component/Composable.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- Composable.java 3 Feb 2003 20:08:44 -0000 1.15
+++ Composable.java 4 Feb 2003 09:15:32 -0000 1.16
@@ -85,7 +85,7 @@
* execution.
*
* @param componentManager The <code>ComponentManager</code> which this
- * <code>Composable</code> uses.
+ * <code>Composable</code> uses. Must not be <code>null</code>.
* @throws ComponentException if an error occurs
*/
void compose( ComponentManager componentManager )
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
