Merge master into dev/v3

Author: thomasmny

buildsystem-api/javadoc/overview.html

@@ -3,7 +3,7 @@
     BuildSystem is a utility plugin targeted towards build-teams.
     It allows worlds to be easily managed and also provides handy tools to assist with building.
 </p>
-<h4>Useful Links</h4>
+<h1>Useful Links</h1>
 <ul>
     <li><a target="_top" href="https://buildsystem.eintosti.de">Project Website</a></li>
     <li><a target="_top" href="https://github.com/thomasmny/BuildSystem">Source Code</a></li>

buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/BuildWorld.java

@@ -59,38 +59,21 @@ public interface BuildWorld {
     boolean hasCreator();
 
     /**
-     * Get the name of the player who created the world.
+     * Get the world's creator.
      * <p>
-     * In older versions of the plugin, the creator was not saved which is why {@code null} can be returned.
+     * Must not be set.
      *
-     * @return The name of the player who created the world
+     * @return The builder who created the world, if set, otherwise {@code null}
      */
     @Nullable
-    String getCreator();
+    Builder getCreator();
 
     /**
-     * Set the name of the creator.
+     * Set the creator.
      *
-     * @param creator The name of the creator
+     * @param creator The creator
      */
-    void setCreator(String creator);
-
-    /**
-     * Get the unique-id of the player who created the world.
-     * <p>
-     * In older versions of the plugin, the creator was not saved which is why {@code null} can be returned.
-     *
-     * @return The unique-id of the player who created the world
-     */
-    @Nullable
-    UUID getCreatorId();
-
-    /**
-     * Set the unique-id of the creator.
-     *
-     * @param creatorId The unique-id of the creator
-     */
-    void setCreatorId(UUID creatorId);
+    void setCreator(Builder creator);
 
     /**
      * Gets whether the given player is the creator of the world.

buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/Builder.java

@@ -18,11 +18,56 @@
 package de.eintosti.buildsystem.api.world;
 
 import org.bukkit.entity.Player;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.UUID;
 
 public interface Builder {
 
+    /**
+     * Creates a new {@link Builder} instance with the given uuid and name.
+     *
+     * @param uuid The uuid
+     * @param name The name
+     * @return The builder
+     */
+    static Builder of(UUID uuid, String name) {
+        return new BuilderImpl(uuid, name);
+    }
+
+    /**
+     * Creates a new {@link Builder} instance using the given player.
+     *
+     * @param player The player
+     * @return The builder
+     */
+    static Builder of(Player player) {
+        return of(player.getUniqueId(), player.getName());
+    }
+
+    /**
+     * Creates a new {@link Builder} instance using a serialized string.
+     * <p>
+     * The format of the string must be {@code <uuid>,<name>}.
+     *
+     * @param serialized The serialized builder
+     * @return The builder if all the input is valid, otherwise {@code null}
+     */
+    @Nullable
+    static Builder deserialize(@Nullable String serialized) {
+        if (serialized == null) {
+            return null;
+        }
+
+        String[] parts = serialized.split(BuilderImpl.SEPARATOR);
+        if (parts.length != 2) {
+            return null;
+        }
+
+        return of(UUID.fromString(parts[0]), parts[1]);
+    }
+
+
     /**
      * Returns a unique and persistent id for the builder.
      * <p>
@@ -31,7 +76,7 @@ public interface Builder {
      * @return The uuid
      * @see Player#getUniqueId()
      */
-    UUID getUuid();
+    UUID getUniqueId();
 
     /**
      * Gets the name of the builder.

…osti/buildsystem/world/CraftBuilder.java …i/buildsystem/api/world/BuilderImpl.javabuildsystem-core/src/main/java/de/eintosti/buildsystem/world/CraftBuilder.java renamed to buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/BuilderImpl.java buildsystem-core/src/main/java/de/eintosti/buildsystem/world/CraftBuilder.java renamed to buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/BuilderImpl.java

@@ -15,30 +15,24 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-package de.eintosti.buildsystem.world;
-
-import de.eintosti.buildsystem.api.world.Builder;
-import org.bukkit.entity.Player;
+package de.eintosti.buildsystem.api.world;
 
 import java.util.UUID;
 
-public class CraftBuilder implements Builder {
+final class BuilderImpl implements Builder {
+
+    public static final String SEPARATOR = ",";
 
     private final UUID uuid;
     private String name;
 
-    public CraftBuilder(Player player) {
-        this.uuid = player.getUniqueId();
-        this.name = player.getName();
-    }
-
-    public CraftBuilder(UUID uuid, String name) {
+    BuilderImpl(UUID uuid, String name) {
         this.uuid = uuid;
         this.name = name;
     }
 
     @Override
-    public UUID getUuid() {
+    public UUID getUniqueId() {
         return uuid;
     }
 
@@ -54,6 +48,6 @@ public void setName(String name) {
 
     @Override
     public String toString() {
-        return uuid.toString() + "," + name;
+        return uuid.toString() + SEPARATOR + name;
     }
 }

buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/WorldManager.java

@@ -112,11 +112,12 @@ public interface WorldManager {
      *
      * @param worldName     The name of the world to import
      * @param creator       The builder who should be set as the creator
+     * @param worldType
      * @param generator     The generator type used by the world
      * @param generatorName The name of the custom generator if generator type is {@link Generator#CUSTOM}
      * @return {@code true} if the world was successfully imported, otherwise {@code false}
      */
-    boolean importWorld(String worldName, Builder creator, Generator generator, String generatorName);
+    boolean importWorld(String worldName, Builder creator, WorldType worldType, Generator generator, String generatorName);
 
     /**
      * Delete an existing {@link BuildWorld}.

buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/data/WorldType.java

@@ -20,6 +20,7 @@
 import org.bukkit.World.Environment;
 
 public enum WorldType {
+
     /**
      * The equivalent to a default Minecraft world with {@link Environment#NORMAL}.
      */

buildsystem-core/src/main/java/de/eintosti/buildsystem/command/SkullCommand.java

@@ -18,7 +18,6 @@
 package de.eintosti.buildsystem.command;
 
 import com.cryptomorin.xseries.profiles.objects.Profileable;
-import de.eintosti.buildsystem.BuildSystem;
 import de.eintosti.buildsystem.BuildSystemPlugin;
 import de.eintosti.buildsystem.Messages;
 import de.eintosti.buildsystem.util.InventoryUtils;

buildsystem-core/src/main/java/de/eintosti/buildsystem/command/subcommand/worlds/AddBuilderSubCommand.java

@@ -21,13 +21,13 @@
 import de.eintosti.buildsystem.BuildSystemPlugin;
 import de.eintosti.buildsystem.Messages;
 import de.eintosti.buildsystem.api.world.BuildWorld;
+import de.eintosti.buildsystem.api.world.Builder;
 import de.eintosti.buildsystem.command.subcommand.Argument;
 import de.eintosti.buildsystem.command.subcommand.SubCommand;
 import de.eintosti.buildsystem.tabcomplete.WorldsTabComplete;
 import de.eintosti.buildsystem.util.PlayerChatInput;
 import de.eintosti.buildsystem.util.UUIDFetcher;
 import de.eintosti.buildsystem.world.BuildWorldManager;
-import de.eintosti.buildsystem.world.CraftBuilder;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 

buildsystem-core/src/main/java/de/eintosti/buildsystem/command/subcommand/worlds/ImportAllSubCommand.java

@@ -19,14 +19,14 @@
 
 import de.eintosti.buildsystem.BuildSystemPlugin;
 import de.eintosti.buildsystem.Messages;
+import de.eintosti.buildsystem.api.world.Builder;
 import de.eintosti.buildsystem.api.world.generator.Generator;
 import de.eintosti.buildsystem.command.subcommand.Argument;
 import de.eintosti.buildsystem.command.subcommand.SubCommand;
 import de.eintosti.buildsystem.tabcomplete.WorldsTabComplete;
 import de.eintosti.buildsystem.util.ArgumentParser;
 import de.eintosti.buildsystem.util.UUIDFetcher;
 import de.eintosti.buildsystem.world.BuildWorldManager;
-import de.eintosti.buildsystem.world.CraftBuilder;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 

buildsystem-core/src/main/java/de/eintosti/buildsystem/command/subcommand/worlds/ImportSubCommand.java

@@ -20,19 +20,15 @@
 import de.eintosti.buildsystem.BuildSystemPlugin;
 import de.eintosti.buildsystem.Messages;
 import de.eintosti.buildsystem.api.world.BuildWorld;
+import de.eintosti.buildsystem.api.world.Builder;
+import de.eintosti.buildsystem.api.world.data.WorldType;
 import de.eintosti.buildsystem.api.world.generator.Generator;
 import de.eintosti.buildsystem.command.subcommand.Argument;
 import de.eintosti.buildsystem.command.subcommand.SubCommand;
 import de.eintosti.buildsystem.tabcomplete.WorldsTabComplete;
 import de.eintosti.buildsystem.util.ArgumentParser;
 import de.eintosti.buildsystem.util.UUIDFetcher;
 import de.eintosti.buildsystem.world.BuildWorldManager;
-import de.eintosti.buildsystem.world.CraftBuilder;
-import de.eintosti.buildsystem.world.BuildWorld;
-import de.eintosti.buildsystem.world.Builder;
-import de.eintosti.buildsystem.world.WorldManager;
-import de.eintosti.buildsystem.world.data.WorldType;
-import de.eintosti.buildsystem.world.generator.Generator;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 
@@ -140,7 +136,7 @@ public void execute(Player player, String[] args) {
         }
 
         Messages.sendMessage(player, "worlds_import_started", new AbstractMap.SimpleEntry<>("%world%", worldName));
-        if (worldManager.importWorld(player, worldName, creator, generator, generatorName, true, worldType)) {
+        if (worldManager.importWorld(player, worldName, creator, worldType, generator, generatorName, true)) {
             Messages.sendMessage(player, "worlds_import_finished");
         }
     }