org.apache.commons.pool.KeyedObjectPoolFactory Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.pool;
/**
* A factory for creating {@link KeyedObjectPool}s.
*
* @param the type of keys in this pool
* @param the type of objects held in this pool
*
* @see KeyedObjectPool
*
* @author Rodney Waldhoff
* @version $Revision: 1222388 $ $Date: 2011-12-22 13:28:27 -0500 (Thu, 22 Dec 2011) $
* @since Pool 1.0
*/
public interface KeyedObjectPoolFactory {
/**
* Create a new {@link KeyedObjectPool}.
* @return a new {@link KeyedObjectPool}
* @throws IllegalStateException when this pool factory is not configured properly
*/
KeyedObjectPool createPool() throws IllegalStateException;
}