org.refcodes.command.impls.AbstractUndoable Maven / Gradle / Ivy

Go to download

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

Artifact for command (job) processing purposes according to the command pattern.

There is a newer version: 1.1.1

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// 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/LICENSE-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.command.impls;

import org.refcodes.command.NotUndoableRuntimeException;
import org.refcodes.command.Undoable;
import org.refcodes.component.Component;

/**
 * The {@link AbstractUndoable} implements the {@link Undoable} interface.
 *
 * @param  The context type to use, can by any {@link Component}, service
 *        or POJO.
 * @param  The return type of the {@link Undoable}'s proceedings.
 */
public abstract class AbstractUndoable extends AbstractCommand implements Undoable {

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	@Override
	public boolean isUndoable() {
		return false;
	}

	@Override
	public void undo( CTX aContext ) throws NotUndoableRuntimeException, UnsupportedOperationException {
		throw new UnsupportedOperationException( "This command is not undoable." );
	}

	// /////////////////////////////////////////////////////////////////////////
	// HOOKS:
	// /////////////////////////////////////////////////////////////////////////

}