Repo-Mirror/eco
9
0
Fork 0
Code Issues Releases 2 Activity

restructured some methods

Browse Source
This commit is contained in:
Samuel Pizette
2022-12-11 20:32:23 -05:00
parent 01aa1e708a
commit f1bfa21270
2 changed files with 22 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
eco-api/src/main/java/com/willfp/eco/core/command/CommandBase.java
View File

@@ -113,6 +113,25 @@ public interface CommandBase {
return new ArrayList<>();
}
/**
* Throws an exception containing a langYml key.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
* automatically handles sending the message to the sender.</p>
* <br>
* Works with any CommandBase derivative:
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(Player, List) onExecute(Player, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(Player, List) onExecute(Player, List)}</p>
* ]
*
* @param key key of notification message in langYml
* @throws NotificationException exception thrown
*/
default void notify(@NotNull String key) throws NotificationException {
throw new NotificationException(key);
}
/**
* Throws an exception containing a langYml key if obj is null.
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
@@ -133,10 +152,10 @@ public interface CommandBase {
default @NotNull <T> T notifyNull(@Nullable T obj, @NotNull String key)
throws NotificationException {
if (Objects.isNull(obj)) {
throw new NotificationException(key);
notify(key);
}
return obj;
return Objects.requireNonNull(obj);
}
/**
@@ -183,7 +202,7 @@ public interface CommandBase {
default boolean notifyFalse(boolean condition, @NotNull String key)
throws NotificationException {
if (!condition) {
throw new NotificationException(key);
notify(key);
}
return true;
}

31
eco-api/src/main/kotlin/com/willfp/eco/core/commands/CommandHelpers.kt
View File

@@ -150,14 +150,7 @@ fun CommandBase.addSubcommand(
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
* automatically handles sending the message to the sender.</p>
* <br>
* Works with any CommandBase derivative:
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(Player, List) onExecute(Player, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(Player, List) onExecute(Player, List)}</p>
*
* @param key key of notification message in langYml
* @param <T> the generic type of object
* @return Returns the object given or throws an exception
* @throws NotificationException exception thrown when null
*/
@@ -170,12 +163,6 @@ fun <T> T?.notifyNull(key: String): T {
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
* automatically handles sending the message to the sender.</p>
* <br>
* Works with any CommandBase derivative:
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(Player, List) onExecute(Player, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(Player, List) onExecute(Player, List)}</p>
*
* @param predicate predicate to test
* @param key key of notification message in langYml
* @param <T> the generic type of object
@@ -191,12 +178,6 @@ fun <T> T.notifyFalse(predicate: Predicate<T>, key: String): T {
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
* automatically handles sending the message to the sender.</p>
* <br>
* Works with any CommandBase derivative:
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(Player, List) onExecute(Player, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(Player, List) onExecute(Player, List)}</p>
*
* @param key value in the langYml
* @return Returns the condition given or throws an exception
* @throws NotificationException exception thrown when false
@@ -210,12 +191,6 @@ fun Boolean.notifyFalse(key: String): Boolean {
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
* automatically handles sending the message to the sender.</p>
* <br>
* Works with any CommandBase derivative:
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(Player, List) onExecute(Player, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(Player, List) onExecute(Player, List)}</p>
*
* @param key value in the langYml
* @return Returns the player
* @throws NotificationException exception thrown when invalid playerName
@@ -229,12 +204,6 @@ fun String?.notifyPlayerRequired(key: String): Player {
* <p>The {@link CommandBase#onExecute(CommandSender, List) onExecute } in PluginCommand and SubCommand
* automatically handles sending the message to the sender.</p>
* <br>
* Works with any CommandBase derivative:
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>PluginCommand#{@link com.willfp.eco.core.command.impl.PluginCommand#onExecute(Player, List) onExecute(Player, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(CommandSender, List) onExecute(CommandSender, List)}</p>
* <p>Subcommand#{@link com.willfp.eco.core.command.impl.Subcommand#onExecute(Player, List) onExecute(Player, List)}</p>
*
* @param permission the permission
* @param key value in the langYml
* @return Returns the player