KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > pool > Recyclable


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.avalon.excalibur.pool;
51
52 /**
53  * This interface standardizes the behaviour of a recyclable object.
54  * A recyclable object is defined as an object that can be used to
55  * encapsulate another object without being altered by its content.
56  * Therefore, a recyclable object may be recycled and reused many times.
57  *
58  * This is helpful in cases where recyclable objects are continously
59  * created and destroyed, causing a much greater amount of garbage to
60  * be collected by the JVM garbage collector. By making it recyclable,
61  * it is possible to reduce the GC execution time, thus incrementing the
62  * overall performance of a process and decrementing the chance of
63  * memory overflow.
64  *
65  * Every implementation must provide their own method to allow this
66  * recyclable object to be reused by setting its content.
67  *
68  * @author <a HREF="mailto:stefano@apache.org">Stefano Mazzocchi</a>
69  * @author <a HREF="mailto:peter@apache.org">Peter Donald</a>
70  * @version CVS $Revision: 1.2 $ $Date: 2003/02/20 17:09:24 $
71  * @since 4.0
72  */
73 public interface Recyclable
74     extends Poolable
75 {
76     /**
77      * This method should be implemented to remove all costly resources
78      * in object. These resources can be object references, database connections,
79      * threads, etc. What is categorised as "costly" resources is determined on
80      * a case by case analysis.
81      */
82     void recycle();
83 }
84
Popular Tags