Skip to content

Commit cdc4b82

Browse files
DespicalDespical
committed
Refactor: rename Option to FrameworkOption for clarity
1 parent be9da20 commit cdc4b82

File tree

9 files changed

+38
-39
lines changed

9 files changed

+38
-39
lines changed

‎.github/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ public class ExampleClass extends JavaPlugin {
168168
arguments.sendMessage("Flag Present: " + arguments.isFlagPresent("test"));
169169
}
170170

171-
@me.despical.commandframework.annotations.Option(
171+
@Option(
172172
value = "players",
173173
prefix = "--"
174174
)

‎src/main/java/me/despical/commandframework/CommandFramework.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import me.despical.commandframework.confirmations.ConfirmationManager;
2323
import me.despical.commandframework.cooldown.CooldownManager;
2424
import me.despical.commandframework.debug.DebugLogger;
25-
import me.despical.commandframework.options.Option;
25+
import me.despical.commandframework.options.FrameworkOption;
2626
import me.despical.commandframework.options.OptionManager;
2727
import org.bukkit.command.CommandMap;
2828
import org.bukkit.command.CommandSender;
@@ -89,7 +89,7 @@ private void checkIsAlreadyInitialized() {
8989
}
9090

9191
private void initializeLogger() {
92-
if (this.optionManager.isEnabled(Option.DEBUG)) {
92+
if (this.optionManager.isEnabled(FrameworkOption.DEBUG)) {
9393
this.logger = new DebugLogger();
9494
return;
9595
}
@@ -187,7 +187,7 @@ CommandRegistry getRegistry() {
187187

188188
@ApiStatus.Internal
189189
boolean checkConfirmation(CommandSender sender, final Command command, final Method method) {
190-
if (!this.optionManager.isEnabled(Option.CONFIRMATIONS)) {
190+
if (!this.optionManager.isEnabled(FrameworkOption.CONFIRMATIONS)) {
191191
return false;
192192
}
193193

@@ -236,4 +236,4 @@ public final List<Command> getAllCommands() {
236236
public static CommandFramework getInstance() {
237237
return instance;
238238
}
239-
}
239+
}

‎src/main/java/me/despical/commandframework/CommandHandler.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import me.despical.commandframework.annotations.Command;
66
import me.despical.commandframework.annotations.Completer;
77
import me.despical.commandframework.exceptions.CooldownException;
8+
import me.despical.commandframework.options.FrameworkOption;
89
import me.despical.commandframework.parser.OptionParser;
910
import me.despical.commandframework.utils.Utils;
1011
import org.bukkit.command.CommandExecutor;
@@ -95,7 +96,7 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull org.bukkit.comm
9596
return true;
9697
}
9798

98-
if (!commandFramework.options().isEnabled(me.despical.commandframework.options.Option.CUSTOM_COOLDOWN_CHECKER) && commandFramework.getCooldownManager().hasCooldown(arguments, command, method)) {
99+
if (!commandFramework.options().isEnabled(FrameworkOption.CUSTOM_COOLDOWN_CHECKER) && commandFramework.getCooldownManager().hasCooldown(arguments, command, method)) {
99100
return true;
100101
}
101102

‎src/main/java/me/despical/commandframework/CommandRegistry.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import me.despical.commandframework.annotations.Command;
44
import me.despical.commandframework.annotations.Completer;
55
import me.despical.commandframework.debug.Debug;
6-
import me.despical.commandframework.options.Option;
6+
import me.despical.commandframework.options.FrameworkOption;
77
import me.despical.commandframework.utils.Utils;
88
import org.bukkit.Bukkit;
99
import org.bukkit.command.CommandMap;
@@ -103,7 +103,7 @@ public void setCommandMap(@NotNull CommandMap commandMap) {
103103
*/
104104
protected void registerCommands(@NotNull Object instance) {
105105
CommandFramework commandFramework = CommandFramework.getInstance();
106-
boolean notDebug = !commandFramework.options().isEnabled(Option.DEBUG);
106+
boolean notDebug = !commandFramework.options().isEnabled(FrameworkOption.DEBUG);
107107

108108
for (Method method : instance.getClass().getMethods()) {
109109
if (notDebug && method.isAnnotationPresent(Debug.class)) {
@@ -314,4 +314,4 @@ public Map.Entry<Completer, Map.Entry<Method, Object>> getAssociatedCompleter(@N
314314
return null;
315315
}
316316
}
317-
}
317+
}

‎src/main/java/me/despical/commandframework/confirmations/ConfirmationManager.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import me.despical.commandframework.annotations.Command;
44
import me.despical.commandframework.annotations.Confirmation;
5+
import me.despical.commandframework.options.FrameworkOption;
56
import me.despical.commandframework.utils.SelfExpiringHashMap;
67
import me.despical.commandframework.utils.SelfExpiringMap;
78
import org.bukkit.command.CommandSender;
@@ -21,7 +22,7 @@
2122
* <p>
2223
* Created at 18.07.2024
2324
*
24-
* @see me.despical.commandframework.options.Option#CONFIRMATIONS
25+
* @see FrameworkOption#CONFIRMATIONS
2526
* @see Confirmation
2627
*/
2728
@ApiStatus.Internal
@@ -57,4 +58,4 @@ public boolean checkConfirmations(final CommandSender sender, final Command comm
5758
sender.sendMessage(confirmation.message());
5859
return true;
5960
}
60-
}
61+
}

‎src/main/java/me/despical/commandframework/cooldown/CooldownManager.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import me.despical.commandframework.annotations.Cooldown;
99
import me.despical.commandframework.exceptions.CommandException;
1010
import me.despical.commandframework.exceptions.CooldownException;
11-
import me.despical.commandframework.options.Option;
11+
import me.despical.commandframework.options.FrameworkOption;
1212
import me.despical.commandframework.utils.Utils;
1313
import org.bukkit.command.CommandSender;
1414
import org.jetbrains.annotations.ApiStatus;
@@ -28,7 +28,7 @@
2828
* <p>
2929
* Created at 18.07.2024
3030
*
31-
* @see Option#CUSTOM_COOLDOWN_CHECKER
31+
* @see FrameworkOption#CUSTOM_COOLDOWN_CHECKER
3232
* @see Cooldown
3333
*/
3434
@ApiStatus.Internal
@@ -43,7 +43,7 @@ public CooldownManager(CommandFramework commandFramework) {
4343
}
4444

4545
public boolean hasCooldown(CommandArguments arguments) {
46-
if (!this.commandFramework.options().isEnabled(Option.CUSTOM_COOLDOWN_CHECKER)) {
46+
if (!this.commandFramework.options().isEnabled(FrameworkOption.CUSTOM_COOLDOWN_CHECKER)) {
4747
throw new CommandException("Custom cooldown checker option must be enabled to use CommandArguments#hasCooldown method!");
4848
}
4949

@@ -103,7 +103,7 @@ public boolean hasCooldown(final CommandArguments arguments, final Command comma
103103
}
104104

105105
private boolean handleCooldowns() {
106-
if (!this.commandFramework.options().isEnabled(Option.CUSTOM_COOLDOWN_CHECKER)) {
106+
if (!this.commandFramework.options().isEnabled(FrameworkOption.CUSTOM_COOLDOWN_CHECKER)) {
107107
return true;
108108
}
109109

@@ -128,4 +128,4 @@ private Method getCallingMethod() {
128128

129129
return null;
130130
}
131-
}
131+
}

‎src/main/java/me/despical/commandframework/options/Option.java renamed to ‎src/main/java/me/despical/commandframework/options/FrameworkOption.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
* <p>
88
* Created at 18.07.2024
99
*
10-
* @see Option#CUSTOM_COOLDOWN_CHECKER
11-
* @see Option#CONFIRMATIONS
12-
* @see Option#DEBUG
10+
* @see FrameworkOption#CUSTOM_COOLDOWN_CHECKER
11+
* @see FrameworkOption#CONFIRMATIONS
12+
* @see FrameworkOption#DEBUG
1313
*/
14-
public enum Option {
14+
public enum FrameworkOption {
1515

1616
/**
1717
* This option allows user to call {@link CommandArguments#checkCooldown()} method.
@@ -27,4 +27,4 @@ public enum Option {
2727
* This option enables the debug mode for this framework.
2828
*/
2929
DEBUG
30-
}
30+
}

‎src/main/java/me/despical/commandframework/options/OptionManager.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@
1515
* <p>
1616
* Created at 18.07.2024
1717
*
18-
* @see Option
18+
* @see FrameworkOption
1919
*/
2020
public final class OptionManager {
2121

22-
private final Set<Option> options;
22+
private final Set<FrameworkOption> frameworkOptions;
2323

2424
public OptionManager() {
25-
this.options = EnumSet.noneOf(Option.class);
25+
this.frameworkOptions = EnumSet.noneOf(FrameworkOption.class);
2626
}
2727

28-
public void enableOption(Option option) {
29-
this.options.add(option);
28+
public void enableOption(FrameworkOption frameworkOption) {
29+
this.frameworkOptions.add(frameworkOption);
3030
}
3131

32-
public void enableOptions(Option... options) {
33-
this.options.addAll(Arrays.asList(options));
32+
public void enableOptions(FrameworkOption... frameworkOptions) {
33+
this.frameworkOptions.addAll(Arrays.asList(frameworkOptions));
3434
}
3535

36-
public boolean isEnabled(Option option) {
37-
return this.options.contains(option);
36+
public boolean isEnabled(FrameworkOption frameworkOption) {
37+
return this.frameworkOptions.contains(frameworkOption);
3838
}
39-
}
39+
}

‎src/test/java/me/despical/commandframework/test/CommandRegistrationTest.java

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,8 @@
2424
import be.seeseemelk.mockbukkit.entity.PlayerMock;
2525
import me.despical.commandframework.CommandArguments;
2626
import me.despical.commandframework.CommandFramework;
27-
import me.despical.commandframework.annotations.Command;
28-
import me.despical.commandframework.annotations.Completer;
29-
import me.despical.commandframework.annotations.Cooldown;
30-
import me.despical.commandframework.annotations.Flag;
31-
import me.despical.commandframework.options.Option;
27+
import me.despical.commandframework.annotations.*;
28+
import me.despical.commandframework.options.FrameworkOption;
3229
import org.bukkit.command.CommandSender;
3330
import org.jetbrains.annotations.NotNull;
3431
import org.junit.jupiter.api.AfterEach;
@@ -151,7 +148,7 @@ public void tearDown() {
151148
private CommandFramework createCommandFramework() {
152149
CommandFramework commandFramework = new CommandFrameworkMock(plugin);
153150
commandFramework.addCustomParameter("String", arguments -> arguments.getArgument(0));
154-
commandFramework.options().enableOption(Option.CUSTOM_COOLDOWN_CHECKER);
151+
commandFramework.options().enableOption(FrameworkOption.CUSTOM_COOLDOWN_CHECKER);
155152
commandFramework.registerCommands(new ExampleCommand());
156153
return commandFramework;
157154
}
@@ -214,7 +211,7 @@ public void flagTest(CommandArguments arguments) {
214211
arguments.sendMessage("Flag Present: " + arguments.isFlagPresent("test"));
215212
}
216213

217-
@me.despical.commandframework.annotations.Option(
214+
@Option(
218215
value = "players",
219216
prefix = "--"
220217
)
@@ -233,4 +230,4 @@ public List<String> exampleCommandCompletion() {
233230
return Arrays.asList("first", "second", "third");
234231
}
235232
}
236-
}
233+
}

0 commit comments

Comments
 (0)