Module org.refcodes.command

Package org.refcodes.command

Class AbstractUndoable<CTX,RET,E extends Exception>

java.lang.Object

org.refcodes.command.AbstractCommand<CTX,RET,E>

org.refcodes.command.AbstractUndoable<CTX,RET,E>

Type Parameters:

CTX - The context type to use, can by any Component, service or POJO.

RET - The return type of the Undoable's proceedings.

E - the element type

All Implemented Interfaces:

Command<CTX,RET,E>, Undoable<CTX,RET,E>

public abstract class AbstractUndoable<CTX,RET,E extends Exception>
extends AbstractCommand<CTX,RET,E>
implements Undoable<CTX,RET,E>

The AbstractUndoable implements the Undoable interface.

Constructor Summary

Constructors

Constructor	Description
AbstractUndoable()

Method Summary

Modifier and Type	Method	Description
boolean	isUndoable(CTX aContext)	This method determines whether the Undoable can undo the work it has done.
void	undo(CTX aContext)	This method tries to undo the Undoable in case it was successfully executed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.command.Command

execute

Constructor Details

AbstractUndoable

public AbstractUndoable()

Method Details

isUndoable

public boolean isUndoable(CTX aContext)

This method determines whether the Undoable can undo the work it has done.

Specified by:

isUndoable in interface Undoable<CTX,RET,E extends Exception>

Parameters:

aContext - The target object which is used by the Undoable to do its Undoable.

Returns:

True if undoable.

undo

public void undo(CTX aContext)
          throws NotUndoableRuntimeException,
UnsupportedOperationException

This method tries to undo the Undoable in case it was successfully executed. Test via Undoable.isUndoable(Object) beforehand to see whether a call to Undoable.undo(Object) can be applied.

Specified by:

undo in interface Undoable<CTX,RET,E extends Exception>

Parameters:

aContext - The target object which is used by the Undoable to do its Undoable.

Throws:

NotUndoableRuntimeException - Thrown in case the performed operation cannot be undone, or no operation as been done before by this Undoable.

UnsupportedOperationException - Thrown in case the Undoable does not provide undo facilities.