Disposable

[Stephen McConnell <mc...@osm.net>]

The javadoc in the description of Disposable seems to me to be inconsistent
with the interface.

Here is the current description:
--------------------------------

   /**
    * This interface should be implemented by those classes that
    * need to provide a service that requires some resources to be
    * initialised before being able to operate and properly destroyed
    * before termination and unloading.
    */

    Here is a proposed interface javadoc replacement:
   --------------------------------------------------

   /**
    * The Dispose interface should be implemented by classes that
    * need to dispose of internal resources prior to the destruction
    * of the implementing instance.
    */

Here current operation javadoc
------------------------------

    /**
     * Destroys the service. This method is guaranteed to be called always
     * after the stop() method if this class implements
<code>Stoppable</code>.
     */
    void dispose() throws Exception;

    Here current dispose operation javadoc replacement
   ---------------------------------------------------
    /**
     * The dispose operation will be invoked by a client on completion
     * of the useful life of instance.  An implementation of dispose is
     * responsible for cleanup internal state members and executing any
     * finalisation actions.  This method is guaranteed to be called
     * after the stop() method if the implementing class supports the
     * <code>Stoppable</code>.  If an implementation also supports the
     * Loggable interface, any log related state members may set to null.
     */
    void dispose() throws Exception;

Ok ..?

Cheers, Steve.



---------------------------------------------------------------------
To unsubscribe, e-mail: avalon-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: avalon-dev-help@jakarta.apache.org