You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avalon.apache.org by do...@apache.org on 2001/04/19 13:23:10 UTC
cvs commit: jakarta-avalon/src/java/org/apache/avalon Disposable.java
donaldp 01/04/19 04:23:09
Modified: src/java/org/apache/avalon Disposable.java
Log:
Update disposable docs. Adapted from submissions by "Stephen McConnell" <mc...@osm.net>
Revision Changes Path
1.2 +9 -6 jakarta-avalon/src/java/org/apache/avalon/Disposable.java
Index: Disposable.java
===================================================================
RCS file: /home/cvs/jakarta-avalon/src/java/org/apache/avalon/Disposable.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Disposable.java 2001/02/24 04:01:45 1.1
+++ Disposable.java 2001/04/19 11:23:07 1.2
@@ -8,10 +8,9 @@
package org.apache.avalon;
/**
- * This interface should be implemented by those classes that
- * need to provide a service that requires some resources to be
- * initialized before being able to operate and properly destroyed
- * before termination and unloading.
+ * The Dispose interface should be implemented by classes that
+ * need to dispose of internal resources prior to the destruction
+ * of the implementing instance.
*
* @author <a href="mailto:fede@apache.org">Federico Barbieri</a>
* @author <a href="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
@@ -21,8 +20,12 @@
public interface Disposable
{
/**
- * Destroys the service. This method is guaranteed to be called always
- * after the stop() method if this class implements <code>Stoppable</code>.
+ * The dispose operation will be invoked by a client on completion
+ * of the useful life of instance. This method is guaranteed to be called
+ * after the stop() method if the Component supports the
+ * <code>Stoppable</code> interface. This method is responsible for
+ * releaseing/destroying any resources aquired by the Component
+ * during it's lifecycle.
*/
void dispose()
throws Exception;
---------------------------------------------------------------------
To unsubscribe, e-mail: avalon-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: avalon-dev-help@jakarta.apache.org