com.sk89q.worldedit.operation

Interface Operation

All Known Implementing Classes:

FlatRegionApplicator

public interface Operation

An task that may be split into multiple steps to be run sequentially immediately or at a varying or fixed interval. Operations should attempt to break apart tasks into smaller tasks that can be completed in quicker successions.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Abort the current task.
Operation	resume() Complete the next step.

Method Detail

resume

Operation resume()
                 throws WorldEditException

Complete the next step. If this method returns true, then the method may be called again in the future, or possibly never. If this method returns false, then this method should not be called again.

Returns:

another operation to run that operation again, or null to stop

Throws:

WorldEditException - an error

cancel

void cancel()

Abort the current task. After the this method is called, resume() should not be called at any point in the future. This method should not be called after successful completion of the operation. This method must be called if the operation is interrupted before completion.