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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truecommons-shed Show documentation

Hosts small but useful tools and utilities that didn't fit anywhere else.

There is a newer version: 2.5.0

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

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

/**
 * A resource which can release itself to its associated {@link Pool}.
 *
 * @param   The type of the exceptions thrown by this releasable.
 * @author Christian Schlichtherle
 */
@CleanupObligation
public interface Releasable {

    /**
     * Releases this resource to its pool.
     *
     * @throws IllegalStateException if this resource has already been
     *         released to its pool and the implementation cannot tolerate
     *         this.
     * @throws X if releasing the resource failed for any other reason.
     */
    @DischargesObligation
    void release() throws X;
}