org.biojava.utils.Commitable Maven / Gradle / Ivy

Go to download

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

BioJava core module

There is a newer version: 1.9.7

/*
 *                    BioJava development code
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public Licence.  This should
 * be distributed with the code.  If you do not have a copy,
 * see:
 *
 *      http://www.gnu.org/copyleft/lesser.html
 *
 * Copyright for this code is held jointly by the individual
 * authors.  These should be listed in @author doc comments.
 *
 * For more information on the BioJava project and its aims,
 * or to join the biojava-l mailing list, visit the home page
 * at:
 *
 *      http://www.biojava.org/
 *
 */

package org.biojava.utils;

/**
 * Implementations of Commitable support atomic changes
 * from one known state to another via commit/rollback semantics.
 *
 * @author Matthew Pocock
 * @author Keith James
 * @since 1.3
 */
public interface Commitable {

    /**
     * commit commits pending changes.
     *
     * @throws CommitFailure if an error occurs
     */
    public void commit()
        throws CommitFailure;
  
    /**
     * rollback reverses pending changes to restore
     * initial (or prior commit) state. This always succededs or raises an
     * unchecked exception.
     *
     * 
     * If the rollback fails, you must raise an AssertionFailure.
     */
    public void rollback();
}