• Home
• net.java.truecommons
• truecommons-shed
• 2.3.5
• source code
• Pool.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.java.truecommons.shed.Pool Maven / Gradle / Ivy

/*
 * Copyright (C) 2005-2015 Schlichtherle IT Services.
 * All rights reserved. Use is subject to license terms.
 */
package net.java.truecommons.shed;

import edu.umd.cs.findbugs.annotations.CreatesObligation;
import edu.umd.cs.findbugs.annotations.DischargesObligation;

/**
 * An interface for pooling strategies.
 * 

 * Implementations must be thread-safe.
 * However, this does not necessarily apply to the implementation of its
 * managed resources.
 *
 * @param   the type of the resources managed by this pool.
 * @param   the type of the exceptions thrown by this pool.
 * @author Christian Schlichtherle
 */
public interface Pool {

    /**
     * Allocates a resource from this pool.
     * 

     * Mind that a pool implementation should not hold references to its
     * allocated resources because this could cause a memory leak.
     *
     * @return A resource.
     * @throws X if allocating the resource fails for any reason.
     */
    @CreatesObligation
    R allocate() throws X;

    /**
     * Releases a previously allocated resource to this pool.
     *
     * @param  resource a resource.
     * @throws IllegalArgumentException if the given resource has not been
     *         allocated by this pool and the implementation cannot tolerate
     *         this.
     * @throws X if releasing the resource fails for any other reason.
     */
    @DischargesObligation
    void release(R resource) throws X;
}