View Javadoc

1   /*
2    * Copyright 1999-2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.pool;
18  
19  /***
20   * A base implemenation of {@link KeyedPoolableObjectFactory KeyedPoolableObjectFactory}.
21   * <p>
22   * All operations defined here are essentially no-op's.
23   *
24   * @see KeyedPoolableObjectFactory
25   *
26   * @author Rodney Waldhoff
27   * @version $Revision: 155430 $ $Date: 2005-02-26 08:13:28 -0500 (Sat, 26 Feb 2005) $ 
28   */
29  public abstract class BaseKeyedPoolableObjectFactory implements KeyedPoolableObjectFactory {
30      public abstract Object makeObject(Object key)
31          throws Exception;
32  
33      /*** No-op. */
34      public void destroyObject(Object key, Object obj)
35          throws Exception {
36      }
37  
38      /***
39       * This implementation always returns <tt>true</tt>.
40       * @return <tt>true</tt>
41       */
42      public boolean validateObject(Object key, Object obj) {
43          return true;
44      }
45  
46      /*** No-op. */
47      public void activateObject(Object key, Object obj)
48          throws Exception {
49      }
50  
51      /*** No-op. */
52      public void passivateObject(Object key, Object obj) 
53          throws Exception {
54      }
55  }