com.landawn.abacus.pool.ObjectPool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of abacus-util-se Show documentation

A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.

There is a newer version: 2.1.12

/*
 * Copyright (C) 2015 HaiYang Li
 *
 * 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 com.landawn.abacus.pool;

import java.util.concurrent.TimeUnit;

// TODO: Auto-generated Javadoc
/**
 * The Interface ObjectPool.
 *
 * @author Haiyang Li
 * @param 
 * @since 0.8
 */
public interface ObjectPool extends Pool {

    /**
     *
     * @param e
     * @return true, if successful
     */
    boolean add(E e);

    /**
     *
     * @param e
     * @param autoDestroyOnFailedToAdd
     * @return true, if successful
     */
    boolean add(E e, boolean autoDestroyOnFailedToAdd);

    /**
     *
     * @param e
     * @param timeout
     * @param unit
     * @return true, if successful
     * @throws InterruptedException the interrupted exception
     */
    boolean add(E e, long timeout, TimeUnit unit) throws InterruptedException;

    /**
     *
     * @param e
     * @param timeout
     * @param unit
     * @param autoDestroyOnFailedToAdd
     * @return true, if successful
     * @throws InterruptedException the interrupted exception
     */
    boolean add(E e, long timeout, TimeUnit unit, boolean autoDestroyOnFailedToAdd) throws InterruptedException;

    /**
     * Retrieves and removes the head of this queue, or returns null if this queue is empty.
     * 
     * @return
     */
    E take();

    /**
     *
     * @param timeout
     * @param unit
     * @return
     * @throws InterruptedException the interrupted exception
     */
    E take(long timeout, TimeUnit unit) throws InterruptedException;

    /**
     *
     * @param e
     * @return boolean
     */
    boolean contains(E e);

    /**
     * The Interface MemoryMeasure.
     *
     * @param 
     */
    public static interface MemoryMeasure {

        /**
         *
         * @param e
         * @return
         */
        long sizeOf(E e);
    }
}