/**
* Copyright 2011 Google Inc.
*
* 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 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.waveprotocol.box.webclient.util;
/**
* A pool of objects with recycling.
*
* @author hearnden@google.com (David Hearnden)
*/
public interface Pool<T> {
/**
* Retrieves an item, either from the free pool or by creating a new one.
*
* @return an item ready to use.
*/
T get();
/**
* Recycles an item. The item is returned to the free pool, potentially
* asynchronously, after it has been recycled.
*
* @param item item to recycle
*/
void recycle(T item);
}