leosutic 2003/02/04 01:14:17
Modified: src/java/org/apache/avalon/framework/configuration
Configurable.java
Log:
Some Javadoc changes - the text could be read in such a way as to mean that the
configure() method must be called *first* in the lifecycle (i.e. before
enableLogging,
contextualize, and so on), which contradicts the Avalon lifecycle document.
(As well as contradicts what most containers actually *do*.)
Revision Changes Path
1.13 +4 -6
jakarta-avalon/src/java/org/apache/avalon/framework/configuration/Configurable.java
Index: Configurable.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/configuration/Configurable.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Configurable.java 23 Nov 2002 08:58:58 -0000 1.12
+++ Configurable.java 4 Feb 2003 09:14:17 -0000 1.13
@@ -57,12 +57,11 @@
/**
* This interface should be implemented by classes that need to be
* configured with custom parameters before initialization.
- * <br />
+ * <br/>
*
* The contract surrounding a <code>Configurable</code> is that the
* instantiating entity must call the <code>configure</code>
- * method before it is valid. The <code>configure</code> method
- * must be called after the constructor, and before any other method.
+ * method before it is valid.
* <br/>
*
* Note that this interface is incompatible with Parameterizable.
@@ -74,10 +73,9 @@
{
/**
* Pass the <code>Configuration</code> to the <code>Configurable</code>
- * class. This method must always be called after the constructor
- * and before any other method.
+ * class.
*
- * @param configuration the class configurations.
+ * @param configuration the class configurations. Must not be <code>null</code>.
* @throws ConfigurationException if an error occurs
*/
void configure( Configuration configuration )
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
