Move PlotAPI to Core and move bukkit specific methods to BukkitUtil.

Core/src/main/java/com/github/intellectualsites/plotsquared/api/PlotAPI.java

@@ -0,0 +1,225 @@
+package com.github.intellectualsites.plotsquared.api;
+
+import com.github.intellectualsites.plotsquared.configuration.file.YamlConfiguration;
+import com.github.intellectualsites.plotsquared.plot.PS;
+import com.github.intellectualsites.plotsquared.plot.config.C;
+import com.github.intellectualsites.plotsquared.plot.flag.Flag;
+import com.github.intellectualsites.plotsquared.plot.flag.Flags;
+import com.github.intellectualsites.plotsquared.plot.object.Plot;
+import com.github.intellectualsites.plotsquared.plot.object.PlotArea;
+import com.github.intellectualsites.plotsquared.plot.object.PlotPlayer;
+import com.github.intellectualsites.plotsquared.plot.util.ChunkManager;
+import com.github.intellectualsites.plotsquared.plot.util.MainUtil;
+import com.github.intellectualsites.plotsquared.plot.util.SchematicHandler;
+import com.github.intellectualsites.plotsquared.plot.util.UUIDHandler;
+import com.github.intellectualsites.plotsquared.plot.util.block.GlobalBlockQueue;
+import com.github.intellectualsites.plotsquared.plot.uuid.UUIDWrapper;
+import lombok.NoArgsConstructor;
+
+import java.util.Collections;
+import java.util.Set;
+import java.util.UUID;
+
+/**
+ * PlotSquared API.
+ * <p>
+ * <p>Useful classes:
+ * <ul>
+ * <li>{@link PlotPlayer}</li>
+ * <li>{@link Plot}</li>
+ * <li>{@link com.github.intellectualsites.plotsquared.plot.object.Location}</li>
+ * <li>{@link PlotArea}</li>
+ * <li>{@link PS}</li>
+ * </ul>
+ *
+ * @version 3.3.3
+ */
+@NoArgsConstructor
+public class PlotAPI {
+
+    /**
+     * Get all plots.
+     *
+     * @return all plots
+     * @see PS#getPlots()
+     */
+    public Set<Plot> getAllPlots() {
+        return PS.get().getPlots();
+    }
+
+    /**
+     * Return all plots for a player.
+     *
+     * @param player Player, whose plots to search for
+     * @return all plots that a player owns
+     */
+    public Set<Plot> getPlayerPlots(PlotPlayer player) {
+        return PS.get().getPlots(player);
+    }
+
+    /**
+     * Add a plot world.
+     *
+     * @param plotArea Plot World Object
+     * @see PS#addPlotArea(PlotArea)
+     */
+    public void addPlotArea(PlotArea plotArea) {
+        PS.get().addPlotArea(plotArea);
+    }
+
+    /**
+     * Returns the PlotSquared configurations file.
+     *
+     * @return main configuration
+     * @see PS#config
+     */
+    public YamlConfiguration getConfig() {
+        return PS.get().config;
+    }
+
+    /**
+     * Get the PlotSquared storage file.
+     *
+     * @return storage configuration
+     * @see PS#storage
+     */
+    public YamlConfiguration getStorage() {
+        return PS.get().storage;
+    }
+
+    /**
+     * Get the main class for this plugin. Only use this if you really need it.
+     *
+     * @return PlotSquared PlotSquared Main Class
+     * @see PS
+     */
+    public PS getMain() {
+        return PS.get();
+    }
+
+    /**
+     * ChunkManager class contains several useful methods.
+     * <ul>
+     * <li>Chunk deletion</li>
+     * <li>Moving or copying regions</li>
+     * <li>Plot swapping</li>
+     * <li>Entity Tracking</li>
+     * <li>Region Regeneration</li>
+     * </ul>
+     *
+     * @return ChunkManager
+     * @see ChunkManager
+     */
+    public ChunkManager getChunkManager() {
+        return ChunkManager.manager;
+    }
+
+    /**
+     * Get the block/biome set queue
+     *
+     * @return GlobalBlockQueue.IMP
+     */
+    public GlobalBlockQueue getBlockQueue() {
+        return GlobalBlockQueue.IMP;
+    }
+
+    /**
+     * UUIDWrapper class has basic methods for getting UUIDS. It's recommended
+     * to use the UUIDHandler class instead.
+     *
+     * @return UUIDWrapper
+     * @see UUIDWrapper
+     */
+    public UUIDWrapper getUUIDWrapper() {
+        return UUIDHandler.getUUIDWrapper();
+    }
+
+    /**
+     * SchematicHandler class contains methods related to pasting, reading
+     * and writing schematics.
+     *
+     * @return SchematicHandler
+     * @see SchematicHandler
+     */
+    public SchematicHandler getSchematicHandler() {
+        return SchematicHandler.manager;
+    }
+
+    /**
+     * Get a list of PlotAreas in the world.
+     *
+     * @param world The world to check for plot areas
+     * @return A set of PlotAreas
+     */
+    public Set<PlotArea> getPlotAreas(String world) {
+        if (world == null) {
+            return Collections.emptySet();
+        }
+        return PS.get().getPlotAreas(world);
+    }
+
+    /**
+     * Send a message to the console. The message supports color codes.
+     *
+     * @param message the message
+     * @see MainUtil#sendConsoleMessage(C, String...)
+     */
+    public void sendConsoleMessage(String message) {
+        PS.log(message);
+    }
+
+    /**
+     * Send a message to the console.
+     *
+     * @param caption the message
+     * @see #sendConsoleMessage(String)
+     * @see C
+     */
+    public void sendConsoleMessage(C caption) {
+        sendConsoleMessage(caption.s());
+    }
+
+    /**
+     * Registers a flag for use in plots.
+     *
+     * @param flag the flag to register
+     */
+    public void addFlag(Flag<?> flag) {
+        Flags.registerFlag(flag);
+    }
+
+    /**
+     * Gets the PlotSquared class.
+     *
+     * @return PlotSquared Class
+     * @see PS
+     */
+    public PS getPlotSquared() {
+        return PS.get();
+    }
+
+    /**
+     * Get the PlotPlayer for a UUID.
+     * <p>
+     * <p><i>Please note that PlotSquared can be configured to provide
+     * different UUIDs than bukkit</i>
+     *
+     * @param uuid the uuid of the player to wrap
+     * @return a {@code PlotPlayer}
+     * @see PlotPlayer#wrap(Object)
+     */
+    public PlotPlayer wrapPlayer(UUID uuid) {
+        return PlotPlayer.wrap(uuid);
+    }
+
+    /**
+     * Get the PlotPlayer for a username.
+     *
+     * @param player the player to wrap
+     * @return a {@code PlotPlayer}
+     * @see PlotPlayer#wrap(Object)
+     */
+    public PlotPlayer wrapPlayer(String player) {
+        return PlotPlayer.wrap(player);
+    }
+}