From f3abbf59583bb29047133f8fedac63ac661a9133 Mon Sep 17 00:00:00 2001 From: broccolai Date: Wed, 21 Oct 2020 18:58:31 +0100 Subject: [PATCH] Fix code style issues in jda --- .../commandframework/jda/JDA4CommandManager.java | 12 ++++++++++-- .../commandframework/jda/JDACommandManager.java | 9 ++++++++- .../commandframework/jda/JDACommandPreprocessor.java | 2 +- .../cloud/commandframework/jda/JDACommandSender.java | 8 ++++---- .../cloud/commandframework/jda/JDAGuildSender.java | 4 ++-- .../cloud/commandframework/jda/JDAPrivateSender.java | 8 +++++--- 6 files changed, 30 insertions(+), 13 deletions(-) diff --git a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDA4CommandManager.java b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDA4CommandManager.java index d6483f99..daab714c 100644 --- a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDA4CommandManager.java +++ b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDA4CommandManager.java @@ -47,7 +47,14 @@ public class JDA4CommandManager extends JDACommandManager { * @param jda JDA instance to register against * @param prefixMapper Function that maps the sender to a command prefix string * @param permissionMapper Function used to check if a command sender has the permission to execute a command - * @param commandExecutionCoordinator Coordination provider + * @param commandExecutionCoordinator Execution coordinator instance. The coordinator is in charge of executing incoming + * commands. Some considerations must be made when picking a suitable execution coordinator + * for your platform. For example, an entirely asynchronous coordinator is not suitable + * when the parsers used in that particular platform are not thread safe. If you have + * commands that perform blocking operations, however, it might not be a good idea to + * use a synchronous execution coordinator. In most cases you will want to pick between + * {@link CommandExecutionCoordinator#simpleCoordinator()} and + * {@link cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator} * @param commandSenderMapper Function that maps {@link JDACommandSender} to the command sender type * @param backwardsCommandSenderMapper Function that maps the command sender type to {@link JDACommandSender} * @throws InterruptedException If the jda instance does not ready correctly @@ -61,7 +68,8 @@ public class JDA4CommandManager extends JDACommandManager { final @NonNull Function<@NonNull C, @NonNull JDACommandSender> backwardsCommandSenderMapper ) throws InterruptedException { - super(jda, + super( + jda, prefixMapper, permissionMapper, commandExecutionCoordinator, diff --git a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandManager.java b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandManager.java index 1d42ea48..fd52a7ec 100644 --- a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandManager.java +++ b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandManager.java @@ -61,7 +61,14 @@ public class JDACommandManager extends CommandManager { * @param jda JDA instance to register against * @param prefixMapper Function that maps the sender to a command prefix string * @param permissionMapper Function used to check if a command sender has the permission to execute a command - * @param commandExecutionCoordinator Coordination provider + * @param commandExecutionCoordinator Execution coordinator instance. The coordinator is in charge of executing incoming + * commands. Some considerations must be made when picking a suitable execution coordinator + * for your platform. For example, an entirely asynchronous coordinator is not suitable + * when the parsers used in that particular platform are not thread safe. If you have + * commands that perform blocking operations, however, it might not be a good idea to + * use a synchronous execution coordinator. In most cases you will want to pick between + * {@link CommandExecutionCoordinator#simpleCoordinator()} and + * {@link cloud.commandframework.execution.AsynchronousCommandExecutionCoordinator} * @param commandSenderMapper Function that maps {@link MessageReceivedEvent} to the command sender type * @param backwardsCommandSenderMapper Function that maps the command sender type to {@link MessageReceivedEvent} * @throws InterruptedException If the jda instance does not ready correctly diff --git a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandPreprocessor.java b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandPreprocessor.java index e78ad4dd..25ad8a4d 100644 --- a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandPreprocessor.java +++ b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandPreprocessor.java @@ -51,7 +51,7 @@ final class JDACommandPreprocessor implements CommandPreprocessor { */ @Override public void accept(final @NonNull CommandPreprocessingContext context) { - context.getCommandContext().store("JDA", mgr.getJDA()); + context.getCommandContext().store("JDA", this.mgr.getJDA()); } } diff --git a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandSender.java b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandSender.java index 1400d817..0b31fe18 100644 --- a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandSender.java +++ b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDACommandSender.java @@ -65,7 +65,7 @@ public class JDACommandSender { * @param event Message Received Event * @return Constructed JDA Command Sender */ - public static JDACommandSender of(final @NonNull MessageReceivedEvent event) { + public static @NonNull JDACommandSender of(final @NonNull MessageReceivedEvent event) { if (event.isFromType(ChannelType.PRIVATE)) { return new JDAPrivateSender(event, event.getAuthor(), event.getPrivateChannel()); } @@ -79,7 +79,7 @@ public class JDACommandSender { * @return Optional of the message receive event */ public final @NonNull Optional getEvent() { - return Optional.ofNullable(event); + return Optional.ofNullable(this.event); } /** @@ -88,7 +88,7 @@ public class JDACommandSender { * @return User that sent the message */ public final @NonNull User getUser() { - return user; + return this.user; } /** @@ -97,7 +97,7 @@ public class JDACommandSender { * @return Channel that the message was sent in */ public final @NonNull MessageChannel getChannel() { - return channel; + return this.channel; } } diff --git a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAGuildSender.java b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAGuildSender.java index 118f9ee3..10281be3 100644 --- a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAGuildSender.java +++ b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAGuildSender.java @@ -60,7 +60,7 @@ public class JDAGuildSender extends JDACommandSender { * @return Member that sent the message */ public @NonNull Member getMember() { - return member; + return this.member; } /** @@ -69,7 +69,7 @@ public class JDAGuildSender extends JDACommandSender { * @return Channel that the message was sent in */ public @NonNull TextChannel getTextChannel() { - return channel; + return this.channel; } } diff --git a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAPrivateSender.java b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAPrivateSender.java index 608d69f4..0b1f36a9 100644 --- a/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAPrivateSender.java +++ b/cloud-discord/cloud-jda/src/main/java/cloud/commandframework/jda/JDAPrivateSender.java @@ -44,7 +44,9 @@ public class JDAPrivateSender extends JDACommandSender { * @param channel Channel sent in */ public JDAPrivateSender( - final @Nullable MessageReceivedEvent event, final @NonNull User user, final @NonNull PrivateChannel channel + final @Nullable MessageReceivedEvent event, + final @NonNull User user, + final @NonNull PrivateChannel channel ) { super(event, user, channel); this.channel = channel; @@ -55,8 +57,8 @@ public class JDAPrivateSender extends JDACommandSender { * * @return Channel that the message was sent in */ - public PrivateChannel getPrivateChannel() { - return channel; + public @NonNull PrivateChannel getPrivateChannel() { + return this.channel; } }