org.refcodes.mixin.Restartable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-mixin Show documentation

Artifact for mixins of general interest.

There is a newer version: 3.3.8

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany, distributed
// on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, and licen-
// sed under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/TEXT-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.mixin;

/**
 * Any implementing instance's status can be set back that the instance's
 * functionality can begin over again. For example an original counter,
 * iterator, loop or set of flags is restored after it has been modified.
 * 
 * The {@link Abortable} interface's method {@link Abortable#abort()} may be
 * used to skip any iterations left (in case of an implemented iterator or
 * loop).
 */
public interface Restartable {

	/**
	 * Sets the status of the instance so that operation with the instance can
	 * begin over again.
	 */
	void restart();
}