1 package org.apache.fulcrum.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 recycled several times by
24 * different clients.
25 *
26 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
27 * @version $Id$
28 */
29 public interface Recyclable
30 {
31
32 /**
33 * Recycles the object for a new client. Recycle methods with parameters must be
34 * added to implementing object and they will be automatically called by pool
35 * implementations when the object is taken from the pool for a new client. The
36 * parameters must correspond to the parameters of the constructors of the
37 * object. For new objects, constructors can call their corresponding recycle
38 * methods whenever applicable. The recycle methods must call their super.
39 */
40 public void recycle();
41
42 /**
43 * Disposes the object after use. The method is called when the object is
44 * returned to its pool. The dispose method must call its super.
45 */
46 public void dispose();
47
48 /**
49 * Checks whether the recyclable has been disposed.
50 *
51 * @return true, if the recyclable is disposed.
52 */
53 public boolean isDisposed();
54 }