asterix-runtime/src/main/java/edu/uci/ics/asterix/runtime/util/container/IObjectPool.java

/*
 * Copyright 2009-2010 by The Regents of the University of California
 * Licensed 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 from
 * 
 *     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 edu.uci.ics.asterix.runtime.util.container;

/**
 * A reusable object pool interface.
 */
public interface IObjectPool<E, T> {

    /**
     * Give client an E instance
     * 
     * @param arg
     *            the argument to create E
     * @return an E instance
     */
    public E allocate(T arg);

    /**
     * Mark all instances in the pool as unused
     */
    public void reset();
}