/*
 * ============================================================================
 * GNU Lesser General Public License
 * ============================================================================
 *
 * Beanlet - JSE Application Container.
 * Copyright (C) 2006  Leon van Zantvoort
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 * 
 * Leon van Zantvoort
 * 243 Acalanes Drive #11
 * Sunnyvale, CA 94086
 * USA
 *
 * zantvoort@users.sourceforge.net
 * http://beanlet.org
 */
package org.beanlet.common;

import java.util.List;

/**
 * @author Leon van Zantvoort
 */
public interface ObjectPool<T> {

    void init(Factory<T> factory);
    
    T getInstance() throws InterruptedException;
    
    /**
     * @return {@code true} if instance has been delivered to pool 
     * successfully, the instance will be returned by the destroy method.
     * {@code false} otherwise.
     */
    boolean freeInstance(T instance);
    
    /**
     * @return {@code true} if instance has been discarded 
     * successfully, the instance will not be returned by the destroy method.
     * {@code false} otherwise.
     */
    boolean discardInstance(T instance);
    
    List<T> destroy();
    
    /**
     * Returns {@code true} if pool has been destroyed and all instances
     * have been returned to pool, {@code false} otherwise.
     */
    boolean isDestroyed();
    
    public interface Factory<T> {
        T newInstance();
    }
}