Upstream/Multiverse-Core
1
0
Fork 0
mirror of https://github.com/Multiverse/Multiverse-Core.git synced 2025-02-03 22:21:30 +01:00
Code Issues Projects Releases Wiki Activity

Cleanup MultiverseCommand and add docs

Browse Source
This commit is contained in:
Ben Woo 2023-09-20 12:18:04 +08:00
parent db0d5da5ce
commit bbfc1a05e8
No known key found for this signature in database
GPG Key ID: FB2A3645536E12C8
1 changed files with 33 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/main/java/org/mvplugins/multiverse/core/commandtools/MultiverseCommand.java
View File

@ -11,15 +11,26 @@ import org.mvplugins.multiverse.core.commandtools.flags.CommandFlagGroup;
import org.mvplugins.multiverse.core.commandtools.flags.CommandFlagsManager; import org.mvplugins.multiverse.core.commandtools.flags.CommandFlagsManager;
import org.mvplugins.multiverse.core.commandtools.flags.ParsedCommandFlags; import org.mvplugins.multiverse.core.commandtools.flags.ParsedCommandFlags;
/**
* Base class for all Multiverse commands.
*/
@Contract @Contract
public abstract class MultiverseCommand extends BaseCommand { public abstract class MultiverseCommand extends BaseCommand {
/**
* The command manager with multiverse specific methods.
*/
protected final MVCommandManager commandManager; protected final MVCommandManager commandManager;
/**
* The flags manager for the above command manager.
*/
protected final CommandFlagsManager flagsManager;
private String flagGroupName; private String flagGroupName;
private CommandFlagGroup.Builder flagGroupBuilder; private CommandFlagGroup.Builder flagGroupBuilder;
protected MultiverseCommand(@NotNull MVCommandManager commandManager) { protected MultiverseCommand(@NotNull MVCommandManager commandManager) {
this.commandManager = commandManager; this.commandManager = commandManager;
this.flagsManager = commandManager.getFlagsManager();
} }
@PostConstruct @PostConstruct
@ -30,10 +41,22 @@ public abstract class MultiverseCommand extends BaseCommand {
} }
} }
protected CommandFlagsManager getFlagsManager() { private void registerFlagGroup(@NotNull CommandFlagGroup flagGroup) {
return commandManager.getFlagsManager(); if (flagGroupName != null) {
throw new IllegalStateException("Flag group already registered! (name: " + flagGroupName + ")");
}
flagsManager.registerFlagGroup(flagGroup);
flagGroupName = flagGroup.getName();
Logging.finest("Registered flag group: " + flagGroupName);
} }
/**
* Add a new flag to the flag builder.
*
* @param flag The flag to add.
* @param <T> The type of the flag.
* @return The flag.
*/
protected <T extends CommandFlag> T flag(T flag) { protected <T extends CommandFlag> T flag(T flag) {
if (flagGroupBuilder == null) { if (flagGroupBuilder == null) {
flagGroupBuilder = CommandFlagGroup.builder("mv" + getClass().getSimpleName().toLowerCase()); flagGroupBuilder = CommandFlagGroup.builder("mv" + getClass().getSimpleName().toLowerCase());
@ -43,16 +66,13 @@ public abstract class MultiverseCommand extends BaseCommand {
return flag; return flag;
} }
protected void registerFlagGroup(@NotNull CommandFlagGroup flagGroup) { /**
if (flagGroupName != null) { * Parses flags.
throw new IllegalStateException("Flag group already registered! (name: " + flagGroupName + ")"); *
} * @param flags The raw string array to parse into flags.
getFlagsManager().registerFlagGroup(flagGroup); * @return The parsed flags.
flagGroupName = flagGroup.getName(); */
Logging.fine("Registered flag group: " + flagGroupName);
}
protected @NotNull ParsedCommandFlags parseFlags(@NotNull String[] flags) { protected @NotNull ParsedCommandFlags parseFlags(@NotNull String[] flags) {
return getFlagsManager().parse(flagGroupName, flags); return flagsManager.parse(flagGroupName, flags);
} }
} }