Algorithm.java

/*
 * Algorithm.java - This file is part of the Jakstab project.
 * Copyright 2007-2015 Johannes Kinder <jk@jakstab.org>
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, see <http://www.gnu.org/licenses/>.
 */
package org.jakstab;

/**
 * A generic interface for algorithms that can be gracefully stopped at 
 * runtime.
 * 
 * @author Johannes Kinder
 */
public interface Algorithm extends Runnable {
	
	/**
	 * Starts the algorithm.
	 */
	public void run();
	
	/**
	 * Orders the algorithm to stop at the next possible moment. Typically
	 * initiated by user interaction.
	 */
	public void stop();
}