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>KeyedPoolableObjectFactory</code>.
22   * <p>
23   * All operations defined here are essentially no-op's.
24   *
25   * @see KeyedPoolableObjectFactory
26   *
27   * @author Rodney Waldhoff
28   * @version $Revision: 480413 $ $Date: 2006-11-28 22:16:05 -0700 (Tue, 28 Nov 2006) $
29   * @since Pool 1.0
30   */
31  public abstract class BaseKeyedPoolableObjectFactory implements KeyedPoolableObjectFactory {
32      public abstract Object makeObject(Object key)
33          throws Exception;
34  
35      /*** No-op. */
36      public void destroyObject(Object key, Object obj)
37          throws Exception {
38      }
39  
40      /***
41       * This implementation always returns <tt>true</tt>.
42       * @return <tt>true</tt>
43       */
44      public boolean validateObject(Object key, Object obj) {
45          return true;
46      }
47  
48      /*** No-op. */
49      public void activateObject(Object key, Object obj)
50          throws Exception {
51      }
52  
53      /*** No-op. */
54      public void passivateObject(Object key, Object obj) 
55          throws Exception {
56      }
57  }