001/*
002 * PlotSquared, a land and world management plugin for Minecraft.
003 * Copyright (C) IntellectualSites <https://intellectualsites.com>
004 * Copyright (C) IntellectualSites team and contributors
005 *
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
018 */
019package com.plotsquared.core.queue;
020
021public abstract class ChunkCoordinator implements Runnable {
022
023    /**
024     * Starts the chunk coordinator. This will usually (implementation-specific-permitting) mark chunks to be loaded in batches,
025     * then add them to a queue and apply tickets once loaded to prevent unloading. A repeating task will then iterate over loaded
026     * chunks, access them with a Consumer(BlockVector2) and remove the ticket once work has been completed on it.
027     */
028    public abstract void start();
029
030    /**
031     * Cancel the chunk coordinator.
032     * @since 6.0.10
033     */
034    public abstract void cancel();
035
036    /**
037     * Get the amount of remaining chunks (at the time of the method call)
038     *
039     * @return Snapshot view of remaining chunk count
040     */
041    public abstract int getRemainingChunks();
042
043    /**
044     * Get the amount of requested chunks
045     *
046     * @return Requested chunk count
047     */
048    public abstract int getTotalChunks();
049
050}