dorkbox.objectPool.ObjectPool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ObjectPool Show documentation

Fast, lightweight, and compatible blocking/non-blocking/soft-reference object pool for Java 8+

There is a newer version: 4.4

/*
 * Copyright 2014 dorkbox, llc
 *
 * 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 dorkbox.objectPool;

import java.util.concurrent.ArrayBlockingQueue;

/**
 * @author dorkbox, llc
 */
public
class ObjectPool {
    private final ArrayBlockingQueue queue;
    private final PoolableObject poolableObject;

    /**
     * Gets the version number.
     */
    public static
    String getVersion() {
        return "1.10";
    }

    public
    ObjectPool(PoolableObject poolableObject, int size) {
        this.poolableObject = poolableObject;

        this.queue = new ArrayBlockingQueue(size);

        for (int x = 0; x < size; x++) {
            T e = poolableObject.create();
            poolableObject.onReturn(e);
            this.queue.add(e);
        }
    }

    /**
     * Takes an object from the pool, Blocks until an item is available in the pool.
     */
    public
    T take() throws InterruptedException {
        final T take = this.queue.take();
        poolableObject.onTake(take);
        return take;
    }

    /**
     * Takes an object from the pool, Blocks until an item is available in the pool.
     * 
     * This method catches {@link InterruptedException} and discards it silently.
     */
    @SuppressWarnings({"Duplicates", "SpellCheckingInspection"})
    public
    T takeUninterruptibly() {
        try {
            T take = take();
            return take;
        } catch (InterruptedException e) {
            return null;
        }
    }

    /**
     * Return object to the pool, waking the threads that have blocked during take()
     */
    public
    void release(T object) {
        poolableObject.onReturn(object);
        this.queue.offer(object);
    }

    /**
     * @return a new object instance created by the pool.
     */
    public
    T newInstance() {
        return poolableObject.create();
    }


    /**
     * @return the number of currently pooled objects
     */
    public
    int size() {
        return queue.size();
    }
}