Class PaperCleanupExecutor

java.lang.Object

com.cotani.cleanup.paper.PaperCleanupExecutor

All Implemented Interfaces:

CleanupExecutor

public final class PaperCleanupExecutor
extends Object
implements CleanupExecutor

Paper/Folia adapter that scans loaded chunks and removes entities on their owning entity threads.

Constructor Summary

Constructors

Constructor	Description
PaperCleanupExecutor(com.cotani.task.api.PaperTaskScheduler scheduler)
PaperCleanupExecutor(com.cotani.task.api.PaperTaskScheduler scheduler, CleanupProtection protection)

Method Summary

Modifier and Type	Method	Description
CompletionStage<CleanupRemovalResult>	removeAsync(CleanupPolicy policy, List<CleanupEntitySnapshot> candidates)	Revalidates and removes the supplied snapshots on their owning entity or region threads.
CompletionStage<CleanupScan>	scanAsync(CleanupPolicy policy)	Scans loaded areas and returns immutable snapshots; it must not remove anything.

Methods inherited from class Object

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

Constructor Details

PaperCleanupExecutor

public PaperCleanupExecutor(com.cotani.task.api.PaperTaskScheduler scheduler)

PaperCleanupExecutor

public PaperCleanupExecutor(com.cotani.task.api.PaperTaskScheduler scheduler,
 CleanupProtection protection)

Method Details

scanAsync

public CompletionStage<CleanupScan> scanAsync(CleanupPolicy policy)

Description copied from interface: CleanupExecutor

Scans loaded areas and returns immutable snapshots; it must not remove anything. Implementations must perform Bukkit/Paper access on the owning server thread.

Specified by:

scanAsync in interface CleanupExecutor

removeAsync

public CompletionStage<CleanupRemovalResult> removeAsync(CleanupPolicy policy,
 List<CleanupEntitySnapshot> candidates)

Description copied from interface: CleanupExecutor

Revalidates and removes the supplied snapshots on their owning entity or region threads. A missing or changed entity should be reported as skipped instead of failing the whole run.

Specified by:

removeAsync in interface CleanupExecutor