001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.pool;
019    
020    /**
021     * A factory for creating {@link KeyedObjectPool}s.
022     *
023     * @param <K> the type of keys in this pool
024     * @param <V> the type of objects held in this pool
025     * 
026     * @see KeyedObjectPool
027     *
028     * @author Rodney Waldhoff
029     * @version $Revision: 1222388 $ $Date: 2011-12-22 13:28:27 -0500 (Thu, 22 Dec 2011) $
030     * @since Pool 1.0
031     */
032    public interface KeyedObjectPoolFactory<K, V> {
033        /**
034         * Create a new {@link KeyedObjectPool}.
035         * @return a new {@link KeyedObjectPool}
036         * @throws IllegalStateException when this pool factory is not configured properly
037         */
038        KeyedObjectPool<K, V> createPool() throws IllegalStateException;
039    }