Deprecate MultiStageReorder and ReorderMode (#1999)

* Start deprecating MultiStage reorder

* Rather than changing behaviour just deprecate

* Add deprecation message

* Apply PR review notes

Author: me4502

worldedit-core/src/main/java/com/sk89q/worldedit/EditSession.java

@@ -212,6 +212,7 @@ public enum Stage {
      * NONE = Place blocks without worrying about placement order.
      * </p>
      */
+    @Deprecated
     public enum ReorderMode {
         MULTI_STAGE("multi"),
         FAST("fast"),
@@ -398,6 +399,7 @@ public void enableStandardMode() {
      *
      * @param reorderMode The reorder mode
      */
+    @Deprecated
     public void setReorderMode(ReorderMode reorderMode) {
         //FAWE start - we don't do physics so we don't need this
         switch (reorderMode) {
@@ -419,6 +421,7 @@ public void setReorderMode(ReorderMode reorderMode) {
      *
      * @return the reorder mode
      */
+    @Deprecated
     public ReorderMode getReorderMode() {
         if (isQueueEnabled()) {
             return ReorderMode.MULTI_STAGE;
@@ -480,7 +483,7 @@ public void setBlockChangeLimit(long limit) {
      * Returns queue status.
      *
      * @return whether the queue is enabled
-     * @deprecated Use {@link EditSession#getReorderMode()} with MULTI_STAGE instead.
+     * @deprecated Use {@link EditSession#isBufferingEnabled()} instead.
      */
     @Deprecated
     public boolean isQueueEnabled() {
@@ -493,7 +496,7 @@ public boolean isQueueEnabled() {
      * Queue certain types of block for better reproduction of those blocks. Uses
      * {@link ReorderMode#MULTI_STAGE}.
      *
-     * @deprecated Use {@link EditSession#setReorderMode(ReorderMode)} with MULTI_STAGE instead.
+     * @deprecated There is no specific replacement, instead enable what you want specifically.
      */
     @Deprecated
     public void enableQueue() {
@@ -503,7 +506,9 @@ public void enableQueue() {
     }
 
     /**
-     * Disable the queue. This will close the queue.
+     * Disable the queue. This will flush the session.
+     *
+     * @deprecated Use {@link EditSession#disableBuffering()} instead.
      */
     @Deprecated
     public void disableQueue() {
@@ -841,6 +846,15 @@ public void setBatchingChunks(boolean batchingChunks) {
         //FAWE end
     }
 
+    /**
+     * Check if this session has any buffering extents enabled.
+     *
+     * @return {@code true} if any extents are buffering
+     */
+    public boolean isBufferingEnabled() {
+        return isBatchingChunks();
+    }
+
     /**
      * Disable all buffering extents.
      *

worldedit-core/src/main/java/com/sk89q/worldedit/LocalSession.java

@@ -1828,6 +1828,7 @@ public void setFastMode(boolean fastMode) {
      *
      * @return The reorder mode
      */
+    @Deprecated
     public EditSession.ReorderMode getReorderMode() {
         return EditSession.ReorderMode.FAST;
     }
@@ -1837,6 +1838,7 @@ public EditSession.ReorderMode getReorderMode() {
      *
      * @param reorderMode The reorder mode
      */
+    @Deprecated
     public void setReorderMode(EditSession.ReorderMode reorderMode) {
     }
 

worldedit-core/src/main/java/com/sk89q/worldedit/extent/reorder/MultiStageReorder.java

@@ -22,6 +22,7 @@
 import com.sk89q.worldedit.WorldEditException;
 import com.sk89q.worldedit.extent.AbstractBufferingExtent;
 import com.sk89q.worldedit.extent.Extent;
+import com.sk89q.worldedit.extent.world.SideEffectExtent;
 import com.sk89q.worldedit.function.operation.Operation;
 import com.sk89q.worldedit.function.operation.OperationQueue;
 import com.sk89q.worldedit.function.operation.RunContext;
@@ -43,7 +44,10 @@
 
 /**
  * Re-orders blocks into several stages.
+ *
+ * @deprecated Use {@link SideEffectExtent} with {@link SideEffectExtent#setPostEditSimulationEnabled} instead.
  */
+@Deprecated
 public class MultiStageReorder extends AbstractBufferingExtent implements ReorderingExtent {
 
     private static final Map<BlockType, PlacementPriority> priorityMap = new HashMap<>();