Package com.fastasyncworldedit.core.extent.processor

Class BatchProcessorHolder

java.lang.Object

com.fastasyncworldedit.core.extent.processor.BatchProcessorHolder

All Implemented Interfaces:

IBatchProcessorHolder, IBatchProcessor

Direct Known Subclasses:

ExtentBatchProcessorHolder

public class BatchProcessorHolder
extends Object
implements IBatchProcessorHolder

Constructor Summary

Constructors

Constructor	Description
BatchProcessorHolder()

Method Summary

Modifier and Type	Method	Description
void	flush()
IBatchProcessor	getPostProcessor()
IBatchProcessor	getProcessor()
ProcessorScope	getScope()	Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.
void	postProcess(IChunk chunk, IChunkGet get, IChunkSet set)	Post-process a chunk that has been edited.
Future<?>	postProcessSet(IChunk chunk, IChunkGet get, IChunkSet set)	Post-process a chunk that has been edited.
IChunkSet	processSet(IChunk chunk, IChunkGet get, IChunkSet set)	Process a chunk that has been set.
void	setPostProcessor(IBatchProcessor set)
void	setProcessor(IBatchProcessor set)	Set the held processor
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fastasyncworldedit.core.queue.IBatchProcessor

trimNBT, trimY

Methods inherited from interface com.fastasyncworldedit.core.extent.processor.IBatchProcessorHolder

construct, join, joinPost, processGet, remove

Constructor Details

BatchProcessorHolder

public BatchProcessorHolder()

Method Details

getProcessor

public IBatchProcessor getProcessor()

Specified by:

getProcessor in interface IBatchProcessorHolder

getPostProcessor

public IBatchProcessor getPostProcessor()

Specified by:

getPostProcessor in interface IBatchProcessorHolder

processSet

public IChunkSet processSet(IChunk chunk,
 IChunkGet get,
 IChunkSet set)

Description copied from interface: IBatchProcessor

Process a chunk that has been set.

Specified by:

processSet in interface IBatchProcessor

Specified by:

processSet in interface IBatchProcessorHolder

postProcessSet

public Future<?> postProcessSet(IChunk chunk,
 IChunkGet get,
 IChunkSet set)

Description copied from interface: IBatchProcessor

Post-process a chunk that has been edited. Set should NOT be modified here, changes will NOT be flushed to the world, but MAY be flushed to history. Defaults to nothing as most Processors will not use it. Post-processors that are not technically blocking should override this method to allow post-processors to become blocking if required.

Specified by:

postProcessSet in interface IBatchProcessor

Specified by:

postProcessSet in interface IBatchProcessorHolder

postProcess

public void postProcess(IChunk chunk,
 IChunkGet get,
 IChunkSet set)

Description copied from interface: IBatchProcessor

Post-process a chunk that has been edited. Set should NOT be modified here, changes will NOT be flushed to the world, but MAY be flushed to history. Defaults to nothing as most Processors will not use it. If the post-processor will run tasks asynchronously/not be blocking, use IBatchProcessor.postProcessSet(com.fastasyncworldedit.core.queue.IChunk, com.fastasyncworldedit.core.queue.IChunkGet, com.fastasyncworldedit.core.queue.IChunkSet) to return a Future.

Specified by:

postProcess in interface IBatchProcessor

Specified by:

postProcess in interface IBatchProcessorHolder

flush

public void flush()

Specified by:

flush in interface IBatchProcessor

setProcessor

public void setProcessor(IBatchProcessor set)

Description copied from interface: IBatchProcessorHolder

Set the held processor

Specified by:

setProcessor in interface IBatchProcessorHolder

setPostProcessor

public void setPostProcessor(IBatchProcessor set)

Specified by:

setPostProcessor in interface IBatchProcessorHolder

toString

public String toString()

Overrides:

toString in class Object

getScope

public ProcessorScope getScope()

Description copied from interface: IBatchProcessor

Default to CUSTOM ProcessorScope as we want custom processors people add to be before we write history, but after FAWE does it's own stuff.

Specified by:

getScope in interface IBatchProcessor