Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-10-27 13:59:38 +01:00
Code Issues Projects Releases Wiki Activity

Added convenience methods in CompositeCommand to ignore the Help subcommand if it exists

Browse Source 
It might look useless at first, but it can have practical uses such as placeholders, display and so on.
It is also needed for my in-project new help display.
This commit is contained in:
Florian CUNY 2018-07-18 13:46:40 +02:00
parent d8f783999b
commit 66b33addfb
1 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/main/java/us/tastybento/bskyblock/api/commands/CompositeCommand.java
View File

@ -329,6 +329,22 @@ public abstract class CompositeCommand extends Command implements PluginIdentifi
return subCommands;
}
/**
* Returns a map of sub commands for this command.
* As it needs more calculations to handle the Help subcommand, it is preferable to use {@link #getSubCommands()} when no such distinction is needed.
* @param ignoreHelp Whether the Help subcommand should not be returned in the map or not.
* @return Map of sub commands for this command
* @see #hasSubCommands(boolean)
*/
public Map<String, CompositeCommand> getSubCommands(boolean ignoreHelp) {
if (ignoreHelp && getSubCommand("help").isPresent()) {
Map<String, CompositeCommand> result = subCommands;
result.remove("help");
return result;
}
return getSubCommands();
}
/**
* Convenience method to obtain the user's team leader
* @param world - world to check
@ -344,9 +360,8 @@ public abstract class CompositeCommand extends Command implements PluginIdentifi
return "/" + usage;
}
/**
* Check if this command has a specific sub command
* Check if this command has a specific sub command.
* @param subCommand - sub command
* @return true if this command has this sub command
*/
@ -355,7 +370,7 @@ public abstract class CompositeCommand extends Command implements PluginIdentifi
}
/**
* Check if this command has any sub commands
* Check if this command has any sub commands.
* @return true if this command has subcommands
*/
protected boolean hasSubCommands() {
@ -363,7 +378,18 @@ public abstract class CompositeCommand extends Command implements PluginIdentifi
}
/**
* Convenience method to check if a user has a team
* Check if this command has any sub commands.
* As it needs more calculations to handle the Help subcommand, it is preferable to use {@link #hasSubCommands()} when no such distinction is needed.
* @param ignoreHelp Whether the Help subcommand should not be taken into account or not.
* @return true if this command has subcommands
* @see #getSubCommands(boolean)
*/
protected boolean hasSubCommands(boolean ignoreHelp) {
return !getSubCommands(ignoreHelp).isEmpty();
}
/**
* Convenience method to check if a user has a team.
* @param world - the world to check
* @param user - the User
* @return true if player is in a team
@ -373,7 +399,7 @@ public abstract class CompositeCommand extends Command implements PluginIdentifi
}
/**
* Check if this command is only for players
* Check if this command is only for players.
* @return true or false
*/
public boolean isOnlyPlayer() {