View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.pool;
19  
20  /**
21   * A base implementation of <code>PoolableObjectFactory</code>.
22   * <p>
23   * All operations defined here are essentially no-op's.
24   *
25   * @see PoolableObjectFactory
26   * @see BaseKeyedPoolableObjectFactory
27   *
28   * @author Rodney Waldhoff
29   * @version $Revision: 965336 $ $Date: 2010-07-18 17:58:33 -0700 (Sun, 18 Jul 2010) $
30   * @since Pool 1.0
31   */
32  public abstract class BasePoolableObjectFactory implements PoolableObjectFactory {
33      
34      /**
35       * {@inheritDoc}
36       */
37      public abstract Object makeObject() throws Exception;
38  
39      /**
40       *  No-op.
41       *  
42       *  @param obj ignored
43       */
44      public void destroyObject(Object obj)
45          throws Exception  {
46      }
47  
48      /**
49       * This implementation always returns <tt>true</tt>.
50       * 
51       * @param obj ignored
52       * @return <tt>true</tt>
53       */
54      public boolean validateObject(Object obj) {
55          return true;
56      }
57  
58      /**
59       *  No-op.
60       *  
61       *  @param obj ignored
62       */
63      public void activateObject(Object obj) throws Exception {
64      }
65  
66      /**
67       *  No-op.
68       *  
69       * @param obj ignored
70       */
71      public void passivateObject(Object obj)
72          throws Exception {
73      }
74  }