encapsulated command argument

ArtifactForms · ArtifactForms · commit 411f209feca7 · 2026-04-12T22:25:39.000+02:00
diff --git a/voxels-server/src/main/java/server/commands/AbstractCommand.java b/voxels-server/src/main/java/server/commands/AbstractCommand.java
@@ -2,7 +2,7 @@
 
 public abstract class AbstractCommand implements Command {
 
-  private static final String[] EMPTY_ARGUMENT_LABELS = new String[] {};
+  private static final CommandArgument[] EMPTY_ARGUMENT_LABELS = new CommandArgument[] {};
 
   private static final String[] EMPTY_ALIASES = new String[] {};
 
@@ -17,14 +17,15 @@ public abstract class AbstractCommand implements Command {
 
   @Override
   public String getSyntax() {
-    StringBuilder builder = new StringBuilder();
-    builder.append(getName());
-    for (String arg : getArgumentLabels()) {
-      builder.append(" <");
-      builder.append(arg);
-      builder.append(">");
-    }
-    return builder.toString();
+    //    StringBuilder builder = new StringBuilder();
+    //    builder.append(getName());
+    //    for (CommandArgument arg : getArgumentLabels()) {
+    //      builder.append(" <");
+    //      builder.append(arg.getName());
+    //      builder.append(">");
+    //    }
+    //    return builder.toString();
+    return "";
   }
 
   @Override
@@ -56,7 +57,7 @@ public String[] getAliases() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
+  public CommandArgument[] getArgumentLabels() {
     return EMPTY_ARGUMENT_LABELS;
   }
 }
diff --git a/voxels-server/src/main/java/server/commands/Command.java b/voxels-server/src/main/java/server/commands/Command.java
@@ -12,7 +12,7 @@ public interface Command {
 
   String getPermission();
 
-  String[] getArgumentLabels();
+  CommandArgument[] getArgumentLabels();
 
   String getSyntax();
 
diff --git a/voxels-server/src/main/java/server/commands/CommandArgument.java b/voxels-server/src/main/java/server/commands/CommandArgument.java
@@ -0,0 +1,21 @@
+package server.commands;
+
+public class CommandArgument {
+
+  private final String name;
+
+  private final boolean required;
+
+  public CommandArgument(String name, boolean required) {
+    this.name = name;
+    this.required = required;
+  }
+
+  public String getName() {
+    return name;
+  }
+
+  public boolean isRequired() {
+    return required;
+  }
+}
diff --git a/voxels-server/src/main/java/server/commands/commands/BroadcastCommand.java b/voxels-server/src/main/java/server/commands/commands/BroadcastCommand.java
@@ -1,6 +1,7 @@
 package server.commands.commands;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.permissions.Permissions;
 
@@ -28,8 +29,8 @@ public String getDescription() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"message"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("message", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/ChangeGameModeCommand.java b/voxels-server/src/main/java/server/commands/commands/ChangeGameModeCommand.java
@@ -6,6 +6,7 @@
 
 import common.game.GameMode;
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.commands.CommandMessages;
 import server.gateways.MessageGateway;
@@ -77,8 +78,8 @@ public String getName() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"survival|creative|0|1|s|c"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("survival|creative|0|1|s|c", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/ChunkCommand.java b/voxels-server/src/main/java/server/commands/commands/ChunkCommand.java
@@ -7,6 +7,7 @@
 import common.network.packets.ChunkDataPacket;
 import common.world.ChunkData;
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.network.GameServer;
 import server.permissions.Permissions;
@@ -100,8 +101,8 @@ private void triggerNeighborUpdate(ServerWorld world, GameServer server, int cx,
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"clear"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("clear", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/DeopCommand.java b/voxels-server/src/main/java/server/commands/commands/DeopCommand.java
@@ -4,6 +4,7 @@
 import java.util.UUID;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.MessageGateway;
 import server.gateways.PermissionGateway;
@@ -59,8 +60,8 @@ public void execute(CommandContext ctx) {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("player", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/EchoCommand.java b/voxels-server/src/main/java/server/commands/commands/EchoCommand.java
@@ -1,6 +1,7 @@
 package server.commands.commands;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.permissions.Permissions;
 
@@ -24,8 +25,8 @@ public String getName() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"message"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("message", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/HelpCommand.java b/voxels-server/src/main/java/server/commands/commands/HelpCommand.java
@@ -4,6 +4,7 @@
 
 import server.commands.AbstractCommand;
 import server.commands.Command;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.CommandGateway;
 import server.permissions.Permissions;
@@ -49,8 +50,8 @@ private void renderDetailedHelp(CommandContext ctx, Command cmd) {
     sb.append("§7Description: §f").append(cmd.getDescription()).append("\n");
 
     sb.append("§7Usage: §e/").append(cmd.getName());
-    for (String label : cmd.getArgumentLabels()) {
-      sb.append(" <").append(label).append(">");
+    for (CommandArgument arg : cmd.getArgumentLabels()) {
+      sb.append(" <").append(arg.getName()).append(">");
     }
     sb.append("\n");
 
diff --git a/voxels-server/src/main/java/server/commands/commands/InventoryCommand.java b/voxels-server/src/main/java/server/commands/commands/InventoryCommand.java
@@ -3,6 +3,7 @@
 import java.util.Locale;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.MessageGateway;
 import server.permissions.Permissions;
@@ -50,8 +51,8 @@ private void executeUseCase(CommandContext ctx) {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"clear"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("clear", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/KickCommand.java b/voxels-server/src/main/java/server/commands/commands/KickCommand.java
@@ -3,6 +3,7 @@
 import java.util.UUID;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.events.events.PlayerKickEvent;
 import server.gateways.EventGateway;
@@ -75,8 +76,11 @@ public String getDescription() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player", "reason"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {
+      new CommandArgument("player", true), 
+      new CommandArgument("reason", true)
+    };
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/OpCommand.java b/voxels-server/src/main/java/server/commands/commands/OpCommand.java
@@ -4,6 +4,7 @@
 import java.util.UUID;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.MessageGateway;
 import server.gateways.PermissionGateway;
@@ -58,8 +59,8 @@ public void execute(CommandContext ctx) {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("player", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/PositionCommand.java b/voxels-server/src/main/java/server/commands/commands/PositionCommand.java
@@ -7,6 +7,7 @@
 import common.world.Location;
 import common.world.WorldMath;
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.PlayerGateway;
 import server.permissions.Permissions;
@@ -89,8 +90,8 @@ private String formatChunk(int x, int z) {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("player", false)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/commands/commands/TimeCommand.java b/voxels-server/src/main/java/server/commands/commands/TimeCommand.java
@@ -5,6 +5,7 @@
 
 import common.world.WorldTime;
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.WorldGateway;
 import server.permissions.Permissions;
@@ -154,8 +155,8 @@ public String getPermission() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"set|add|value"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {new CommandArgument("set|add|value", true)};
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/main/ServerMain.java b/voxels-server/src/main/java/server/main/ServerMain.java
@@ -9,6 +9,7 @@
 import common.logging.Log;
 import common.network.NetworkPackets;
 import server.commands.Command;
+import server.commands.CommandArgument;
 import server.config.ServerConfig;
 import server.modules.edit.WorldEditModule;
 import server.modules.moderation.ModerationModule;
@@ -76,11 +77,11 @@ private static void dumpCommandMarkdown(Collection<Command> commands) {
       }
 
       // Arguments
-      String[] args = command.getArgumentLabels();
+      CommandArgument[] args = command.getArgumentLabels();
       if (args.length > 0) {
         builder.append("**Arguments:**\n");
-        for (String arg : args) {
-          builder.append("- `").append(arg).append("`\n");
+        for (CommandArgument arg : args) {
+          builder.append("- `").append(arg.getName()).append("`\n");
         }
         builder.append("\n");
       }
diff --git a/voxels-server/src/main/java/server/modules/moderation/commands/BanCommand.java b/voxels-server/src/main/java/server/modules/moderation/commands/BanCommand.java
@@ -4,6 +4,7 @@
 import java.util.UUID;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.PlayerGateway;
 import server.modules.moderation.ModerationPermissions;
@@ -103,8 +104,12 @@ public String getDescription() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {
+      new CommandArgument("player", true),
+      new CommandArgument("duration", false),
+      new CommandArgument("reason", false),
+    };
   }
 
   @Override
diff --git a/voxels-server/src/main/java/server/modules/moderation/commands/MuteCommand.java b/voxels-server/src/main/java/server/modules/moderation/commands/MuteCommand.java
@@ -4,6 +4,7 @@
 import java.util.UUID;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.PlayerGateway;
 import server.modules.moderation.ModerationMessages;
@@ -102,7 +103,11 @@ public String getDescription() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {
+      new CommandArgument("player", true),
+      new CommandArgument("duration", false),
+      new CommandArgument("reason", false),
+    };
   }
 }
diff --git a/voxels-server/src/main/java/server/modules/moderation/commands/UnmuteCommand.java b/voxels-server/src/main/java/server/modules/moderation/commands/UnmuteCommand.java
@@ -4,6 +4,7 @@
 import java.util.UUID;
 
 import server.commands.AbstractCommand;
+import server.commands.CommandArgument;
 import server.commands.CommandContext;
 import server.gateways.PlayerGateway;
 import server.modules.moderation.ModerationMessages;
@@ -60,7 +61,9 @@ public String getDescription() {
   }
 
   @Override
-  public String[] getArgumentLabels() {
-    return new String[] {"player"};
+  public CommandArgument[] getArgumentLabels() {
+    return new CommandArgument[] {
+      new CommandArgument("player", true),
+    };
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package server.commands.commands;`
`2`	`2`
`3`	`3`	`import server.commands.AbstractCommand;`
	`4`	`+import server.commands.CommandArgument;`
`4`	`5`	`import server.commands.CommandContext;`
`5`	`6`	`import server.permissions.Permissions;`
`6`	`7`
`@@ -28,8 +29,8 @@ public String getDescription() {`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`@Override`
`31`		`- public String[] getArgumentLabels() {`
`32`		`- return new String[] {"message"};`
	`32`	`+ public CommandArgument[] getArgumentLabels() {`
	`33`	`+ return new CommandArgument[] {new CommandArgument("message", true)};`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`@Override`