KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > pool > ObjectPool


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Vivien Quema
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.pool;
26
27 /**
28  * This interface defines an object pool. An object pool aims at improving
29  * performances by avoiding unnecessary object creations.
30  */
31 public interface ObjectPool
32 {
33   /** The commonly used name to refer to this interface. */
34   String JavaDoc ITF_NAME = "object-pool";
35
36   /**
37    * Returns a new instance of object.
38    *
39    * @return a new instance of object.
40    */
41   Recyclable newInstance();
42
43   /**
44    * Recycles the object so that it can be reused.
45    *
46    * @param recyclable the object to be recycled.
47    */
48   void recycleInstance(Recyclable recyclable);
49
50 }
Popular Tags