Package com.fastasyncworldedit.core.extent.processor

Class MultiBatchProcessor

java.lang.Object

com.fastasyncworldedit.core.extent.processor.MultiBatchProcessor

All Implemented Interfaces:

IBatchProcessor

public class MultiBatchProcessor
extends Object
implements IBatchProcessor

Constructor Summary

Constructors

Constructor	Description
MultiBatchProcessor(IBatchProcessor... processors)

Method Summary

Modifier and Type	Method	Description
void	addBatchProcessor(IBatchProcessor processor)
Extent	construct(Extent child)	Convert this processor into an Extent based processor instead of a queue batch based on.
void	flush()
List<IBatchProcessor>	getBatchProcessors()
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.
IBatchProcessor	join(IBatchProcessor other)	Join two processors and return the result.
IBatchProcessor	joinPost(IBatchProcessor other)
static IBatchProcessor	of(IBatchProcessor... processors)
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.
boolean	processGet(int chunkX, int chunkZ)
IChunkSet	processSet(IChunk chunk, IChunkGet get, IChunkSet set)	Process a chunk that has been set.
<T extends IBatchProcessor> IBatchProcessor	remove(Class<T> clazz)	Return a new processor after removing all are instances of a specified class.
void	removeBatchProcessor(IBatchProcessor processor)
void	setFaweExceptionArray(boolean[] faweExceptionReasonsUsed)	Sets the cached boolean array of length FaweException.Type.values().length that determines if a thrown FaweException of type FaweException.Type should be output to console, rethrown to attempt to be visible to the player, etc.
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

Constructor Details

MultiBatchProcessor

public MultiBatchProcessor(IBatchProcessor... processors)

Method Details

of

public static IBatchProcessor of(IBatchProcessor... processors)

addBatchProcessor

public void addBatchProcessor(IBatchProcessor processor)

getBatchProcessors

public List<IBatchProcessor> getBatchProcessors()

removeBatchProcessor

public void removeBatchProcessor(IBatchProcessor processor)

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

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

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

processGet

public boolean processGet(int chunkX,
 int chunkZ)

Specified by:

processGet in interface IBatchProcessor

construct

public 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

remove

public <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

join

public IBatchProcessor join(IBatchProcessor other)

Description copied from interface: IBatchProcessor

Join two processors and return the result.

Specified by:

join in interface IBatchProcessor

joinPost

public IBatchProcessor joinPost(IBatchProcessor other)

Specified by:

joinPost in interface IBatchProcessor

flush

public void flush()

Specified by:

flush in interface IBatchProcessor

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

setFaweExceptionArray

public void setFaweExceptionArray(boolean[] faweExceptionReasonsUsed)

Sets the cached boolean array of length FaweException.Type.values().length that determines if a thrown FaweException of type FaweException.Type should be output to console, rethrown to attempt to be visible to the player, etc. Allows the same array to be used as widely as possible across the edit to avoid spam to console.

Parameters:

faweExceptionReasonsUsed - boolean array that should be cached where this method is called from of length FaweException.Type.values().length