View Javadoc

1   package org.apache.turbine.util.pool;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /***
23   * An interface for objects that can be pooled and
24   * recycled several times by different clients.
25   *
26   * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
27   * @version $Id: Recyclable.java 534527 2007-05-02 16:10:59Z tv $
28   */
29  public interface Recyclable
30  {
31      /***
32       * Recycles the object for a new client. Recycle methods with
33       * parameters must be added to implementing object and they will be
34       * automatically called by pool implementations when the object is
35       * taken from the pool for a new client. The parameters must
36       * correspond to the parameters of the constructors of the object.
37       * For new objects, constructors can call their corresponding recycle
38       * methods whenever applicable.
39       * The recycle methods must call their super.
40       */
41      void recycle();
42  
43      /***
44       * Disposes the object after use. The method is called
45       * when the object is returned to its pool.
46       * The dispose method must call its super.
47       */
48      void dispose();
49  
50      /***
51       * Checks whether the recyclable has been disposed.
52       * @return true, if the recyclable is disposed.
53       */
54      boolean isDisposed();
55  }