Package com.fastasyncworldedit.core.extent.processor

Interface IBatchProcessorHolder

All Superinterfaces:

IBatchProcessor

All Known Subinterfaces:

IQueueExtent<T>

All Known Implementing Classes:

BatchProcessorHolder, ExtentBatchProcessorHolder, SingleThreadQueueExtent

public interface IBatchProcessorHolder
extends IBatchProcessor

Holds a batch processor (Join and remove operations affect the held processor)

Method Summary

Modifier and Type	Method	Description
default Extent	construct(Extent child)	Convert this processor into an Extent based processor instead of a queue batch based on.
IBatchProcessor	getPostProcessor()
IBatchProcessor	getProcessor()
default IBatchProcessor	join(IBatchProcessor other)	Join two processors and return the result.
default IBatchProcessor	joinPost(IBatchProcessor other)
default void	postProcess(IChunk chunk, IChunkGet get, IChunkSet set)	Post-process a chunk that has been edited.
default Future<?>	postProcessSet(IChunk chunk, IChunkGet get, IChunkSet set)	Post-process a chunk that has been edited.
default boolean	processGet(int chunkX, int chunkZ)
default IChunkSet	processSet(IChunk chunk, IChunkGet get, IChunkSet set)	Process a chunk that has been set.
default <T extends IBatchProcessor> IBatchProcessor	remove(Class<T> clazz)	Return a new processor after removing all are instances of a specified class.
void	setPostProcessor(IBatchProcessor set)
void	setProcessor(IBatchProcessor set)	Set the held processor

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

flush, getScope, trimNBT, trimY

Method Details

getProcessor

IBatchProcessor getProcessor()

getPostProcessor

IBatchProcessor getPostProcessor()

setProcessor

void setProcessor(IBatchProcessor set)

Set the held processor

setPostProcessor

void setPostProcessor(IBatchProcessor set)

processSet

default 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

postProcessSet

default 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

postProcess

default 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

processGet

default boolean processGet(int chunkX,
 int chunkZ)

Specified by:

processGet in interface IBatchProcessor

construct

default Extent construct(Extent child)

Description copied from interface: IBatchProcessor

Convert this processor into an Extent based processor instead of a queue batch based on.

Specified by:

construct in interface IBatchProcessor

join

default IBatchProcessor join(IBatchProcessor other)

Description copied from interface: IBatchProcessor

Join two processors and return the result.

Specified by:

join in interface IBatchProcessor

joinPost

default IBatchProcessor joinPost(IBatchProcessor other)

Specified by:

joinPost in interface IBatchProcessor

remove

default <T extends IBatchProcessor> IBatchProcessor remove(Class<T> clazz)

Description copied from interface: IBatchProcessor

Return a new processor after removing all are instances of a specified class.

Specified by:

remove in interface IBatchProcessor