com.elmakers.mine.bukkit.api.batch

Interface Batch

All Known Subinterfaces:

SpellBatch, UndoBatch

public interface Batch

Represents a batched Block update, usually started by a construction Spell.

Magic will process pending BlockBatch requests once every tick, up to a maximum number of Block updates per tick (the default is 1,000).

Every BlockBatch is required to perform only as many updates as requested, and to report how many updates were performed.

A BlockBatch must also report when it is finished, and perform any required actions on finish, such as registering an UndoBatch for undo.

Method Summary

Modifier and Type	Method and Description
void	cancel() Finish this batch and force-cancel any outstanding effects.
void	finish() Immediately finish this batch.
String	getName() Return a friendly name to identify this batch.
boolean	isFinished() Whether or not this batch is finished
int	process(int maxBlocks) Process one iteration of this batch.
int	remaining() The remaining size of this batch.
int	size() The size of this batch.

Method Detail

process

int process(int maxBlocks)

Process one iteration of this batch.

Parameters:

maxBlocks - The maximum number of blocks the batch should process

Returns:

The number of blocks processed.

isFinished

boolean isFinished()

Whether or not this batch is finished

Returns:

true if finished

finish

void finish()

Immediately finish this batch.

This may cancel any remaining operations, but should clean up, add to undo queues, etc, whatever has been done so far.

cancel

void cancel()

Finish this batch and force-cancel any outstanding effects.

size

int size()

The size of this batch. May be in blocks, or some other abstract unit.

Can be used in conjunction with remaining() for a progress indicator.

Returns:

The size of this batch.

remaining

int remaining()

The remaining size of this batch. May be in blocks, or some other abstract unit.

Can be used in conjunction with size() for a progress indicator.

Returns:

The remaining size of this batch.

getName

String getName()

Return a friendly name to identify this batch.

Returns:

A readable name