ObjectPoolFactory.java

/*
 * 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 interface for creating {@link ObjectPool}s.
 *
 * @param <T> the type of objects held in this pool
 * 
 * @see ObjectPool
 *
 * @author Rodney Waldhoff
 * @version $Revision: 1222388 $ $Date: 2011-12-22 13:28:27 -0500 (Thu, 22 Dec 2011) $
 * @since Pool 1.0
 */
public interface ObjectPoolFactory<T> {
    /**
     * Create and return a new {@link ObjectPool}.
     * @return a new {@link ObjectPool}
     * @throws IllegalStateException when this pool factory is not configured properly
     */
    ObjectPool<T> createPool() throws IllegalStateException;
}