View Javadoc

1   package org.apache.turbine.util.pool;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License")
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import org.apache.turbine.util.TurbineException;
20  
21  /***
22   * An interface for objects that can be pooled and recycled several times
23   * by different clients.  Pooled objects that implement this interface
24   * use no argument ctor and recycle methods.  Initialization is taken
25   * care of using the init method.  This is a way to avoid
26   * introspection/reflection when pooling an object.
27   *
28   * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
29   * @version $Id: InitableRecyclable.java 264148 2005-08-29 14:21:04Z henning $
30   */
31  public interface InitableRecyclable extends Recyclable
32  {
33      /***
34       * This method should be called after retrieving the object from
35       * the pool.
36       */
37      void init(Object initObj) throws TurbineException;
38  }