KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > picocontainer > Disposable


1 /*****************************************************************************
2  * Copyright (c) PicoContainer Organization. All rights reserved. *
3  * ------------------------------------------------------------------------- *
4  * The software in this package is published under the terms of the BSD *
5  * style license a copy of which has been included with this distribution in *
6  * the license.html file. *
7  * *
8  * Idea by Rachel Davies, Original code by Aslak Hellesoy and Paul Hammant *
9  *****************************************************************************/
10 package org.picocontainer;
11
12 /**
13  * An interface which is implemented by components that need to dispose of resources during the shutdown of that
14  * component. The {@link Disposable#dispose()} must be called once during shutdown, directly after {@link
15  * Startable#stop()} (if the component implements the {@link Startable} interface).
16  * @version $Revision: 1570 $
17  * @see org.picocontainer.Startable the Startable interface if you need to <code>start()</code> and
18  * <code>stop()</code> semantics.
19  * @see org.picocontainer.PicoContainer the main PicoContainer interface (and hence its subinterfaces and
20  * implementations like {@link org.picocontainer.defaults.DefaultPicoContainer}) implement this interface.
21  * @since 1.0
22  */
23 public interface Disposable {
24     /**
25      * Dispose this component. The component should deallocate all resources. The contract for this method defines a
26      * single call at the end of this component's life.
27      */
28     void dispose();
29 }
30
Popular Tags