Huge changes and improvements on codebase

Author: Despical

src/main/java/me/despical/commandframework/CommandArguments.java

@@ -39,14 +39,20 @@
  * @author Despical
  * @since 1.0.0
  */
-public class CommandArguments {
+public final class CommandArguments {
 
+	final me.despical.commandframework.annotations.Command command;
 	private final CommandSender commandSender;
-	private final Command command;
+	private final Command bukkitCommand;
 	private final String label, arguments[];
 
-	public CommandArguments(CommandSender commandSender, Command command, String label, String... arguments) {
+	CommandArguments(CommandSender commandSender,
+					 Command bukkitCommand,
+					 me.despical.commandframework.annotations.Command command,
+					 String label,
+					 String... arguments) {
 		this.commandSender = commandSender;
+		this.bukkitCommand = bukkitCommand;
 		this.command = command;
 		this.label = label;
 		this.arguments = arguments;
@@ -69,11 +75,22 @@ public <T extends CommandSender> T getSender() {
 	/**
 	 * Retrieves the base command associated with this object.
 	 *
-	 * @return The base command.
+	 * @return the base command.
+	 * @since 1.4.8
+	 */
+	@Nullable
+	public me.despical.commandframework.annotations.Command getCommand() {
+		return this.command;
+	}
+
+	/**
+	 * Retrieves the Bukkit command associated with this object.
+	 *
+	 * @return the base command as a Bukkit command.
 	 */
 	@NotNull
-	public Command getCommand() {
-		return command;
+	public Command getBukkitCommand() {
+		return bukkitCommand;
 	}
 
 	/**
@@ -101,7 +118,7 @@ public String[] getArguments() {
 	/**
 	 * Retrieves the argument at the specified index.
 	 *
-	 * @param index   the index of desired argument.
+	 * @param index the index of desired argument.
 	 * @return indexed element or null if index out of bounds
 	 */
 	@Nullable
@@ -113,8 +130,8 @@ public String getArgument(int index) {
 	 * Returns the indexed element from the arguments array, or the {@code defaultValue}
 	 * if and only if index is out the bounds.
 	 *
-	 * @param index   the index of desired argument.
-	 * @param defaultValue    the default value to return if the index is out of bounds.
+	 * @param index        the index of desired argument.
+	 * @param defaultValue the default value to return if the index is out of bounds.
 	 * @return the argument at the specified index, or the default value if the index is out of bounds.
 	 */
 	@NotNull
@@ -125,9 +142,9 @@ public String getArgument(int index, String defaultValue) {
 	/**
 	 * Returns the integer value of the indexed element from the arguments array.
 	 *
-	 * @param index   the index of desired argument.
+	 * @param index the index of desired argument.
 	 * @return Integer if indexed element is primitive type of int
-	 *         or 0 if element is null.
+	 * or 0 if element is null.
 	 */
 	public int getArgumentAsInt(int index) {
 		return Utils.getInt(this.getArgument(index));
@@ -136,9 +153,9 @@ public int getArgumentAsInt(int index) {
 	/**
 	 * Returns the double value of the indexed element from the arguments array.
 	 *
-	 * @param index   the index of desired argument.
+	 * @param index the index of desired argument.
 	 * @return Double if indexed element is primitive type of double
-	 *         or 0 if element is null.
+	 * or 0 if element is null.
 	 */
 	public double getArgumentAsDouble(int index) {
 		return Utils.getDouble(this.getArgument(index));
@@ -147,9 +164,9 @@ public double getArgumentAsDouble(int index) {
 	/**
 	 * Returns the float value of the indexed element from the arguments array.
 	 *
-	 * @param index   the index of desired argument.
+	 * @param index the index of desired argument.
 	 * @return Float if indexed element is primitive type of float
-	 *         or 0 if element is null.
+	 * or 0 if element is null.
 	 */
 	public float getArgumentAsFloat(int index) {
 		return Utils.getFloat(this.getArgument(index));
@@ -158,9 +175,9 @@ public float getArgumentAsFloat(int index) {
 	/**
 	 * Returns the long value of the indexed element from the arguments array.
 	 *
-	 * @param index   the index of desired argument.
+	 * @param index the index of desired argument.
 	 * @return Long if indexed element is primitive type of long
-	 *         or 0 if element is null.
+	 * or 0 if element is null.
 	 */
 	public long getArgumentAsLong(int index) {
 		return Utils.getLong(this.getArgument(index));
@@ -169,9 +186,9 @@ public long getArgumentAsLong(int index) {
 	/**
 	 * Returns the boolean value of the indexed element from the arguments array.
 	 *
-	 * @param index   the index of desired argument.
+	 * @param index the index of desired argument.
 	 * @return Boolean if indexed element is primitive type of boolean
-	 *         or 0 if element is null.
+	 * or 0 if element is null.
 	 */
 	public boolean getArgumentAsBoolean(int index) {
 		return "true".equalsIgnoreCase(this.getArgument(index));
@@ -191,25 +208,29 @@ public boolean isArgumentsEmpty() {
 	/**
 	 * Sends message to sender without receiving the command sender.
 	 *
-	 * @param message   the message will be sent to sender.
+	 * @param message the message will be sent to sender.
 	 */
 	public void sendMessage(String message) {
 		if (message == null)
 			return;
-		commandSender.sendMessage(CommandFramework.instance.colorFormatter.apply(message));
+		commandSender.sendMessage(Message.applyColorFormatter(message));
 	}
 
 	/**
 	 * Sends message to sender without receiving command
 	 * sender with the given parameters.
 	 *
-	 * @param message   the message will be sent to sender.
-	 * @param params    the parameters to format the message.
+	 * @param message the message will be sent to sender.
+	 * @param params  the parameters to format the message.
 	 */
 	public void sendMessage(String message, Object... params) {
 		if (message == null)
 			return;
-		commandSender.sendMessage(CommandFramework.instance.colorFormatter.apply(MessageFormat.format(message, params)));
+		commandSender.sendMessage(Message.applyColorFormatter(MessageFormat.format(message, params)));
+	}
+
+	public boolean sendMessage(Message message) {
+		return message.sendMessage(command, this);
 	}
 
 	/**
@@ -226,7 +247,7 @@ public boolean isSenderConsole() {
 	 * Returns {@code true} if, and only if, command sender is player.
 	 *
 	 * @return {@code true} if, and only if, command sender is player, otherwise
-	 *         {@code false}.
+	 * {@code false}.
 	 */
 	public boolean isSenderPlayer() {
 		return commandSender instanceof Player;
@@ -236,9 +257,9 @@ public boolean isSenderPlayer() {
 	 * Returns {@code true} if the command sender has required {@code permission} or, if
 	 * {@code permission} is empty.
 	 *
-	 * @param permission   the permission to check.
+	 * @param permission the permission to check.
 	 * @return {@code true} if the command sender has required {@code permission} or, if
-	 *         {@code permission} is empty, otherwise {@code false}.
+	 * {@code permission} is empty, otherwise {@code false}.
 	 */
 	public boolean hasPermission(String permission) {
 		return permission.isEmpty() || commandSender.hasPermission(permission);
@@ -256,14 +277,10 @@ public int getLength() {
 	/**
 	 * Gets player object from the server with given {@code name}.
 	 *
-	 * @param name
-	 *        the name of player.
-	 *
+	 * @param name the name of player.
 	 * @return player with the given name if online, otherwise
-	 *         empty optional.
-	 *
+	 * empty optional.
 	 * @throws IllegalArgumentException if the {@code name} is null.
-	 *
 	 * @see Optional#empty()
 	 * @since 1.3.6
 	 */
@@ -274,21 +291,17 @@ public Optional<Player> getPlayer(String name) {
 	/**
 	 * Gets player object from the server with given argument.
 	 *
-	 * @param index
-	 *        the index of desired argument.
-	 *
+	 * @param index the index of desired argument.
 	 * @return player with the given name if online, otherwise
-	 *         empty optional.
-	 *
+	 * empty optional.
 	 * @throws IllegalArgumentException if given index is out
-	 *         of bounds.
-	 *
+	 *                                  of bounds.
 	 * @see Optional#empty()
 	 * @since 1.3.6
 	 */
 	public Optional<Player> getPlayer(int index) {
-        return this.getPlayer(this.getArgument(index));
-    }
+		return this.getPlayer(this.getArgument(index));
+	}
 
 	/**
 	 * Concatenates all arguments into a single {@code String}
@@ -308,10 +321,10 @@ public String concatenateArguments() {
 	 * @param from the starting index (inclusive) of the range.
 	 * @param to   the ending index (exclusive) of the range.
 	 * @return a string containing the concatenated elements within
-	 *         the specified range, separated by a space.
+	 * the specified range, separated by a space.
 	 * @throws ArrayIndexOutOfBoundsException if {@code from} is negative,
-	 *         {@code to} is greater than the length of the array,
-	 *         or {@code from} is greater than {@code to}.
+	 *                                        {@code to} is greater than the length of the array,
+	 *                                        or {@code from} is greater than {@code to}.
 	 * @since 1.3.8
 	 */
 	public String concatenateRangeOf(int from, int to) {
@@ -322,9 +335,9 @@ public String concatenateRangeOf(int from, int to) {
 	 * Checks if the value obtained from the argument at the specified index is numeric,
 	 * i.e., if it contains only digit characters (0-9).
 	 *
-	 * @param index   The index of the argument from which the value is retrieved.
+	 * @param index The index of the argument from which the value is retrieved.
 	 * @return {@code true} if the value at the specified argument index is numeric, {@code false} otherwise.
-	 *         Returns {@code false} for null or empty values obtained from the argument.
+	 * Returns {@code false} for null or empty values obtained from the argument.
 	 */
 	public boolean isNumeric(int index) {
 		return this.isNumeric(this.getArgument(index));
@@ -333,9 +346,9 @@ public boolean isNumeric(int index) {
 	/**
 	 * Checks if the given string is numeric, i.e., if it contains only digit characters (0-9).
 	 *
-	 * @param string   The input string to be checked for numeric content.
+	 * @param string The input string to be checked for numeric content.
 	 * @return {@code true} if the input string is numeric, {@code false} otherwise.
-	 *         Returns {@code false} for null or empty strings.
+	 * Returns {@code false} for null or empty strings.
 	 */
 	public boolean isNumeric(String string) {
 		if (string == null || string.isEmpty())
@@ -348,10 +361,10 @@ public boolean isNumeric(String string) {
 	 * Checks if the value obtained from the argument at the specified index can be successfully
 	 * parsed into an integer using {@code Integer.parseInt}.
 	 *
-	 * @param index   The index of the argument from which the value is retrieved.
+	 * @param index The index of the argument from which the value is retrieved.
 	 * @return {@code true} if the value at the specified argument index can be parsed into an integer,
-	 *         {@code false} otherwise. Returns {@code false} for null or empty values obtained from the argument.
-	 *         Also returns {@code false} for values that cannot be parsed into an integer.
+	 * {@code false} otherwise. Returns {@code false} for null or empty values obtained from the argument.
+	 * Also returns {@code false} for values that cannot be parsed into an integer.
 	 */
 	public boolean isInteger(int index) {
 		return this.isInteger(this.getArgument(index));
@@ -360,9 +373,9 @@ public boolean isInteger(int index) {
 	/**
 	 * Checks if the given string can be successfully parsed into an integer using {@code Integer.parseInt}.
 	 *
-	 * @param string   The input string to be checked for its ability to be parsed into an integer.
+	 * @param string The input string to be checked for its ability to be parsed into an integer.
 	 * @return {@code true} if the string can be parsed into an integer, {@code false} otherwise.
-	 *         Returns {@code false} for null strings or strings that cannot be parsed into an integer.
+	 * Returns {@code false} for null strings or strings that cannot be parsed into an integer.
 	 */
 	public boolean isInteger(String string) {
 		try {
@@ -377,10 +390,10 @@ public boolean isInteger(String string) {
 	 * Checks if the value obtained from the argument at the specified index can be successfully
 	 * parsed into a floating-point decimal using {@code Double.parseDouble}.
 	 *
-	 * @param index   The index of the argument from which the value is retrieved.
+	 * @param index The index of the argument from which the value is retrieved.
 	 * @return {@code true} if the value at the specified argument index can be parsed into a floating-point decimal,
-	 *         {@code false} otherwise. Returns {@code false} for null or empty values obtained from the argument.
-	 *         Also returns {@code false} for values that cannot be parsed into a floating-point decimal.
+	 * {@code false} otherwise. Returns {@code false} for null or empty values obtained from the argument.
+	 * Also returns {@code false} for values that cannot be parsed into a floating-point decimal.
 	 */
 	public boolean isFloatingDecimal(int index) {
 		return this.isFloatingDecimal(this.getArgument(index));
@@ -390,9 +403,9 @@ public boolean isFloatingDecimal(int index) {
 	 * Checks if the given string can be successfully parsed into a floating decimal using {@code Double.parseDouble}.
 	 * Supports primitive types such as {@code Integer}, {@code Float}, {@code Double}, {@code Long}, etc.
 	 *
-	 * @param string   The input string to be checked for its ability to be parsed into a decimal.
+	 * @param string The input string to be checked for its ability to be parsed into a decimal.
 	 * @return {@code true} if the string can be parsed into a decimal, {@code false} otherwise.
-	 *         Returns {@code false} for null strings or strings that cannot be parsed into a decimal.
+	 * Returns {@code false} for null strings or strings that cannot be parsed into a decimal.
 	 */
 	public boolean isFloatingDecimal(String string) {
 		try {
@@ -402,4 +415,8 @@ public boolean isFloatingDecimal(String string) {
 			return false;
 		}
 	}
+
+	public boolean checkCooldown() {
+		return CommandFramework.instance.getCooldownManager().hasCooldown(this);
+	}
 }