com.sk89q.worldedit.function.visitor

Class RegionVisitor

java.lang.Object

com.sk89q.worldedit.function.visitor.RegionVisitor

All Implemented Interfaces:

Operation

public class RegionVisitor
extends Object
implements Operation

Utility class to apply region functions to Region.

Constructor Summary

Constructors

Constructor and Description
RegionVisitor(Region region, RegionFunction function)

Method Summary

Modifier and Type	Method and Description
void	cancel() Abort the current task.
int	getAffected() Get the number of affected objects.
Operation	resume(RunContext run) Complete the next step.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionVisitor

public RegionVisitor(Region region,
                     RegionFunction function)

Method Detail

getAffected

public int getAffected()

Get the number of affected objects.

Returns:

the number of affected

resume

public Operation resume(RunContext run)
                 throws WorldEditException

Description copied from interface: Operation

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.

Specified by:

resume in interface Operation

Parameters:

run - describes information about the current run

Returns:

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

Throws:

WorldEditException - an error

cancel

public void cancel()

Description copied from interface: Operation

Abort the current task. After the this method is called, Operation.resume(RunContext) 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.

Specified by:

cancel in interface Operation