net.java.truecommons.shed.Resource 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;
import java.io.Closeable;
import java.io.IOException;

/**
 * An abstract closeable resource.
 * 
 * @param   The exception type which may get thrown by {@link #close()}.
 *         If this is an {@link IOException}, then the subclass can implement
 *         the {@link Closeable} interface, too.
 * @author Christian Schlichtherle
 */
@CleanupObligation
public abstract class Resource implements AutoCloseable {

    private boolean closed;

    /**
     * Returns {@code true} iff this resource hasn't been
     *         {@linkplain #close() closed} yet.
     * 
     * @return {@code true} iff this resource hasn't been
     *         {@linkplain #close() closed} yet.
     */
    public boolean isOpen() { return !closed; }

    /**
     * Closes this resource.
     * If this is the first call to this method, then {@link #onClose()} gets
     * called.
     * Otherwhise the call gets ignored.
     * Upon successful return from {@code onClose()}, this resource gets marked
     * as closed, so a subsequent call to this method will do nothing.
     * 
     * @throws X At the discretion of the method {@link #onClose()}.
     */
    @Override
    @DischargesObligation
    public void close() throws X {
        if (closed) return;
        onClose();
        closed = true;
    }

    protected abstract void onClose() throws X;
}