feat: introduce PlotAreaAccessor and WorldNameAccessor interfaces for improved plot and world name access

Author: TheMeinerLP

Core/src/main/java/com/plotsquared/core/accessor/PlotAreaAccessor.java

@@ -0,0 +1,22 @@
+package com.plotsquared.core.accessor;
+
+import com.plotsquared.core.plot.PlotArea;
+
+
+/**
+ * An accessor to get the plot area.
+ *
+ * @since 7.5.7
+ * @version 1.0.0
+ * @author IntellectualSites
+ * @author TheMeinerLP
+ */
+public interface PlotAreaAccessor {
+    /**
+     * Gets the plot world object for this plot<br>
+     * - The generic PlotArea object can be casted to its respective class for more control (e.g. HybridPlotWorld)
+     *
+     * @return PlotArea
+     */
+    PlotArea getArea();
+}

Core/src/main/java/com/plotsquared/core/accessor/WorldNameAccessor.java

@@ -0,0 +1,22 @@
+package com.plotsquared.core.accessor;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+/**
+ * An accessor to get the world name.
+ *
+ * @since 7.5.7
+ * @version 1.0.0
+ * @author IntellectualSites
+ * @author TheMeinerLP
+ */
+public interface WorldNameAccessor {
+
+    /**
+     * Get the name of the world for this object
+     *
+     * @return World name
+     */
+    @NonNull
+    String getWorldName();
+}

Core/src/main/java/com/plotsquared/core/command/ListCmd.java

@@ -25,6 +25,8 @@
 import com.plotsquared.core.configuration.caption.CaptionHolder;
 import com.plotsquared.core.configuration.caption.TranslatableCaption;
 import com.plotsquared.core.database.DBFunc;
+import com.plotsquared.core.accessor.PlotAreaAccessor;
+import com.plotsquared.core.accessor.WorldNameAccessor;
 import com.plotsquared.core.permissions.Permission;
 import com.plotsquared.core.player.PlotPlayer;
 import com.plotsquared.core.plot.Plot;
@@ -56,6 +58,7 @@
 import java.util.Iterator;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Optional;
 import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
@@ -150,8 +153,14 @@ public boolean onCommand(PlotPlayer<?> player, String[] args) {
             page = 0;
         }
 
-        String world = player.getCurrentPlot().getWorldName();
-        PlotArea area = player.getCurrentPlot().getArea();
+        String world = Optional
+                .ofNullable(player.getCurrentPlot())
+                .map(WorldNameAccessor.class::cast)
+                .orElse(player.getLocation())
+                .getWorldName();
+        PlotArea area = Optional.ofNullable(player.getCurrentPlot())
+                .map(PlotAreaAccessor.class::cast)
+                .orElse(player).getArea();
         String arg = args[0].toLowerCase();
         final boolean[] sort = new boolean[]{true};
 

Core/src/main/java/com/plotsquared/core/location/Location.java

@@ -21,20 +21,22 @@
 import com.google.common.base.Objects;
 import com.google.common.base.Preconditions;
 import com.plotsquared.core.PlotSquared;
+import com.plotsquared.core.accessor.WorldNameAccessor;
 import com.plotsquared.core.plot.Plot;
 import com.plotsquared.core.plot.PlotArea;
 import com.sk89q.worldedit.math.BlockVector2;
 import com.sk89q.worldedit.math.BlockVector3;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 import org.khelekore.prtree.MBR;
 import org.khelekore.prtree.SimpleMBR;
 
 /**
  * An unmodifiable 6-tuple (world,x,y,z,yaw,pitch)
  */
 @SuppressWarnings("unused")
-public sealed class Location extends BlockLoc implements Comparable<Location> permits UncheckedWorldLocation {
+public sealed class Location extends BlockLoc implements Comparable<Location>, WorldNameAccessor permits UncheckedWorldLocation {
 
     private final float yaw;
     private final float pitch;
@@ -213,7 +215,7 @@ private Location(
      *
      * @return World name
      */
-    public @NonNull String getWorldName() {
+    public @NonNull @NotNull String getWorldName() {
         return this.world.getName();
     }
 

Core/src/main/java/com/plotsquared/core/location/UncheckedWorldLocation.java

@@ -21,6 +21,7 @@
 import com.intellectualsites.annotations.DoNotUse;
 import com.sk89q.worldedit.math.BlockVector3;
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Used internally for generation to reference locations in worlds that "don't exist yet". There is no guarantee that the world
@@ -75,7 +76,7 @@ private UncheckedWorldLocation(
 
     @Override
     @DoNotUse
-    public @NonNull String getWorldName() {
+    public @NonNull @NotNull String getWorldName() {
         return this.worldName;
     }
 

Core/src/main/java/com/plotsquared/core/player/PlotPlayer.java

@@ -34,6 +34,7 @@
 import com.plotsquared.core.database.DBFunc;
 import com.plotsquared.core.events.TeleportCause;
 import com.plotsquared.core.location.Location;
+import com.plotsquared.core.accessor.PlotAreaAccessor;
 import com.plotsquared.core.permissions.NullPermissionProfile;
 import com.plotsquared.core.permissions.PermissionHandler;
 import com.plotsquared.core.permissions.PermissionProfile;
@@ -87,7 +88,7 @@
 /**
  * The abstract class supporting {@code BukkitPlayer} and {@code SpongePlayer}.
  */
-public abstract class PlotPlayer<P> implements CommandCaller, OfflinePlotPlayer, LocaleHolder {
+public abstract class PlotPlayer<P> implements CommandCaller, OfflinePlotPlayer, LocaleHolder, PlotAreaAccessor {
 
     private static final String NON_EXISTENT_CAPTION = "<red>PlotSquared does not recognize the caption: ";
 
@@ -416,6 +417,11 @@ public PlotArea getApplicablePlotArea() {
         return plot.getArea();
     }
 
+    @Override
+    public PlotArea getArea() {
+        return getApplicablePlotArea();
+    }
+
     @Override
     public @NonNull RequiredType getSuperCaller() {
         return RequiredType.PLAYER;

Core/src/main/java/com/plotsquared/core/plot/Plot.java

@@ -37,6 +37,7 @@
 import com.plotsquared.core.location.BlockLoc;
 import com.plotsquared.core.location.Direction;
 import com.plotsquared.core.location.Location;
+import com.plotsquared.core.accessor.WorldNameAccessor;
 import com.plotsquared.core.permissions.Permission;
 import com.plotsquared.core.player.ConsolePlayer;
 import com.plotsquared.core.player.PlotPlayer;
@@ -78,6 +79,7 @@
 import org.apache.logging.log4j.Logger;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.lang.ref.Cleaner;
 import java.text.DecimalFormat;
@@ -115,7 +117,7 @@
  * - Using the `new` operator will create an unclaimed plot instance
  * - Use the methods from the PlotArea/PS/Location etc to get existing plots
  */
-public class Plot {
+public class Plot implements WorldNameAccessor {
 
     private static final Logger LOGGER = LogManager.getLogger("PlotSquared/" + Plot.class.getSimpleName());
     private static final DecimalFormat FLAG_DECIMAL_FORMAT = new DecimalFormat("0");
@@ -541,7 +543,7 @@ public void setOwnerAbs(final @Nullable UUID owner) {
      *
      * @return World name
      */
-    public @Nullable String getWorldName() {
+    public @Nullable @NotNull String getWorldName() {
         return area.getWorldName();
     }
 

Core/src/main/java/com/plotsquared/core/plot/world/SinglePlot.java

@@ -27,6 +27,7 @@
 import com.sk89q.worldedit.math.BlockVector3;
 import com.sk89q.worldedit.regions.CuboidRegion;
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -58,7 +59,7 @@ public SinglePlot(
     }
 
     @Override
-    public String getWorldName() {
+    public @NotNull String getWorldName() {
         return getId().toUnderscoreSeparatedString();
     }