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 factory interface for creating {@link ObjectPool}s.
22   *
23   * @see ObjectPool
24   *
25   * @author Rodney Waldhoff
26   * @version $Revision: 777748 $ $Date: 2009-05-22 17:00:44 -0700 (Fri, 22 May 2009) $
27   * @since Pool 1.0
28   */
29  public interface ObjectPoolFactory {
30      /**
31       * Create and return a new {@link ObjectPool}.
32       * @return a new {@link ObjectPool}
33       * @throws IllegalStateException when this pool factory is not configured properly
34       */
35      ObjectPool createPool() throws IllegalStateException;
36  }