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 /**
24 * An interface for objects that can be pooled and recycled several times
25 * by different clients. Pooled objects that implement this interface
26 * use no argument or recycle methods. Initialization is taken
27 * care of using the init method. This is a way to avoid
28 * introspection/reflection when pooling an object.
29 *
30 * @author <a href="mailto:jmcnally@collab.net">John McNally</a>
31 * @version $Id$
32 */
33 public interface InitableRecyclable extends Recyclable
34 {
35 /**
36 * This method should be called after retrieving the object from
37 * the pool.
38 *
39 * @param initObj the object to initialize
40 * @throws PoolException pool exception if failed to initialize
41 */
42 public void init(Object initObj) throws PoolException;
43 }