Added docs

Author: darichey

src/main/java/com/darichey/discord/Command.java

@@ -6,6 +6,10 @@
 import java.util.Set;
 import java.util.function.Consumer;
 
+/**
+ * A command to be executed in Discord. This holds a set of {@link Limiter}s that determine if the command can be executed in a given context as well
+ * as a function to be called should all of the limiters pass.
+ */
 @SuppressWarnings("WeakerAccess")
 public class Command {
 
@@ -17,38 +21,72 @@ private Command(Consumer<CommandContext> onCalled, Set<Limiter> limiters) {
 		this.limiters = limiters;
 	}
 
+	/**
+	 * Gets the function that is executed when the command is called.
+	 * @return The function that is executed when the command is called.
+	 */
 	public Consumer<CommandContext> getOnCalled() {
 		return onCalled;
 	}
 
+	/**
+	 * Gets the limiters which determine if the command can be executed in a given context.
+	 * @return The limiters which determine if the command can be executed in a given context.
+	 */
 	public Set<Limiter> getLimiters() {
 		return limiters;
 	}
 
+	/**
+	 * Gets a builder that can be used to build a new Command.
+	 * @return A new command builder.
+	 */
 	public static Builder builder() {
 		return new Builder();
 	}
 
+	/**
+	 * Used to build Command instances.
+	 */
 	public static class Builder {
 
 		private Consumer<CommandContext> onCalled;
 		private Set<Limiter> limiters = new HashSet<>();
 
+		/**
+		 * Sets the function that is executed when the command is called.
+		 * @param onCalled The function that is executed when the command is called.
+		 * @return The builder instance.
+		 */
 		public Builder onCalled(Consumer<CommandContext> onCalled) {
 			this.onCalled = onCalled;
 			return this;
 		}
 
+		/**
+		 * Adds a limiter to the set of limiters for the command.
+		 * @param limiter The limiter to add.
+		 * @return The builder instance.
+		 */
 		public Builder limiter(Limiter limiter) {
 			this.limiters.add(limiter);
 			return this;
 		}
 
+		/**
+		 * Sets all of the limiters that determine if the command can be executed in a given context.
+		 * @param limiters The limiters to set.
+		 * @return The builder instance.
+		 */
 		public Builder limiters(Set<Limiter> limiters) {
 			this.limiters = limiters;
 			return this;
 		}
 
+		/**
+		 * Builds the command instance.
+		 * @return The command instance.
+		 */
 		public Command build() {
 			return new Command(onCalled, limiters);
 		}

src/main/java/com/darichey/discord/CommandContext.java

@@ -10,7 +10,11 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * Provides information about the context in which a command was executed.
+ */
 public class CommandContext {
+
 	private final IDiscordClient client;
 	private final String name;
 	private final List<String> args;
@@ -19,7 +23,7 @@ public class CommandContext {
 	private final IChannel channel;
 	private final IUser author;
 
-	public CommandContext(MessageReceivedEvent event, String prefix, String name, String args) {
+	CommandContext(MessageReceivedEvent event, String name, String args) {
 		this.client = event.getClient();
 		this.name = name;
 		this.args = Arrays.asList(args.split("\\s+"));
@@ -29,30 +33,58 @@ public CommandContext(MessageReceivedEvent event, String prefix, String name, St
 		this.author = event.getAuthor();
 	}
 
+	/**
+	 * Gets the client that received the message this context was built from.
+	 * @return The client that received the message this context was built from.
+	 */
 	public IDiscordClient getClient() {
 		return client;
 	}
 
+	/**
+	 * Gets the name of the command that was executed.
+	 * @return The name of the command that was executed.
+	 */
 	public String getName() {
 		return name;
 	}
 
+	/**
+	 * Gets the arguments of the command that was executed.
+	 * @return The arguments of the command that was executed.
+	 */
 	public List<String> getArgs() {
 		return args;
 	}
 
+	/**
+	 * Gets the message that this context was built from.
+	 * @return The message that this context was built from.
+	 */
 	public IMessage getMessage() {
 		return message;
 	}
 
+	/**
+	 * Gets the guild in which the message that this context was built from was received.
+	 * @return The guild in which the message that this context was built from was received.
+	 */
 	public IGuild getGuild() {
 		return guild;
 	}
 
+	/**
+	 * Gets the channel in which the message that this context was built from was received.
+	 * @return The channel in which the message that this context was built from was received.
+	 */
 	public IChannel getChannel() {
 		return channel;
 	}
 
+	/**
+	 * Gets the author of the message that this context was built from.
+	 * @return The author of the message that this context was built from.
+	 */
 	public IUser getAuthor() {
 		return author;
 	}

src/main/java/com/darichey/discord/CommandListener.java

@@ -3,6 +3,10 @@
 import sx.blah.discord.api.events.IListener;
 import sx.blah.discord.handle.impl.events.guild.channel.message.MessageReceivedEvent;
 
+/**
+ * Listens for messages which start with the prefix specified by a {@link CommandRegistry} and attempts to parse and call the correct command.
+ */
+@SuppressWarnings("WeakerAccess")
 public class CommandListener  implements IListener<MessageReceivedEvent> {
 
 	private final CommandRegistry registry;
@@ -26,7 +30,7 @@ public void handle(MessageReceivedEvent event) {
 
 			String args = name.length() == prefixRemoved.length() ? "" : prefixRemoved.substring(name.length() + 1);
 
-			registry.call(name, new CommandContext(event, prefix, name, args));
+			registry.call(name, new CommandContext(event, name, args));
 		}
 	}
 }

src/main/java/com/darichey/discord/CommandRegistry.java

@@ -6,6 +6,10 @@
 
 import java.util.*;
 
+/**
+ * The point of access for calling commands. This can hold default limiters which are automatically applied to all commands as well as guild-specific
+ * prefixes.
+ */
 @SuppressWarnings("WeakerAccess")
 public class CommandRegistry {
 
@@ -29,62 +33,109 @@ public CommandRegistry(String defaultPrefix, Limiter... defaultLimiters) {
 		Collections.addAll(this.defaultLimiters, defaultLimiters);
 	}
 
+	/**
+	 * Calls a command with the given name, if it exists.
+	 * @param name The name of the command to call.
+	 * @param ctx The context to give to the command function.
+	 */
 	public void call(String name, CommandContext ctx) {
-		getCommand(name).ifPresent(cmd -> {
-			for (Limiter limiter : defaultLimiters) {
-				if (!limiter.check(ctx)) {
-					limiter.onFail(ctx);
-					return;
-				}
+		getCommand(name).ifPresent(cmd -> call(cmd, ctx));
+	}
+
+	private void call(Command cmd, CommandContext ctx) {
+		for (Limiter limiter : defaultLimiters) {
+			if (!limiter.check(ctx)) {
+				limiter.onFail(ctx);
+				return;
 			}
+		}
 
-			for (Limiter limiter : cmd.getLimiters()) {
-				if (!limiter.check(ctx)) {
-					limiter.onFail(ctx);
-					return;
-				}
+		for (Limiter limiter : cmd.getLimiters()) {
+			if (!limiter.check(ctx)) {
+				limiter.onFail(ctx);
+				return;
 			}
+		}
 
-			cmd.getOnCalled().accept(ctx);
-		});
+		cmd.getOnCalled().accept(ctx);
 	}
 
+	/**
+	 * Associates a command to a name and optional aliases.
+	 * @param command The command to register.
+	 * @param name The name to associate with the command.
+	 * @param aliases The aliases to associate with the command. (Or none)
+	 */
 	public void register(Command command, String name, String... aliases) {
 		register(command, name);
 		for (String alias : aliases) {
 			register(command, alias);
 		}
 	}
-
 	private void register(Command command, String name) {
 		if (commands.containsKey(name)) throw new IllegalArgumentException("Attempt to register two commands with the same name: " + name);
 		commands.put(name, command);
 	}
 
+	/**
+	 * Optionally returns the command associated with the given name;
+	 * @param name The name to look up.
+	 * @return The command associated with the given name.
+	 */
 	public Optional<Command> getCommand(String name) {
 		return Optional.ofNullable(commands.get(name));
 	}
 
+	/**
+	 * Sets a guild-specific prefix.
+	 * @param guild The guild to set the prefix in.
+	 * @param prefix The prefix to set.
+	 */
 	public void overwritePrefix(IGuild guild, String prefix) {
 		overwritePrefix(guild.getLongID(), prefix);
 	}
 
+	/**
+	 * Sets a guild-specific prefix.
+	 * @param id The id of the guild to set the prefix in.
+	 * @param prefix The prefix to set.
+	 */
 	public void overwritePrefix(long id, String prefix) {
 		guildPrefixes.put(id, prefix);
 	}
 
+	/**
+	 * Optionally returns the guild-specific prefix for the given guild.
+	 * @param guild The guild to look up.
+	 * @return The guild-specific prefix for the given guild.
+	 */
 	public Optional<String> getPrefixForGuild(IGuild guild) {
 		return getPrefixForGuild(guild.getLongID());
 	}
 
+	/**
+	 * Optionally returns the guild-specific prefix for the given guild.
+	 * @param id The id of the guild to look up.
+	 * @return The guild-specific prefix for the given guild.
+	 */
 	public Optional<String> getPrefixForGuild(long id) {
 		return Optional.ofNullable(guildPrefixes.get(id));
 	}
 
+	/**
+	 * Gets the prefix for the given guild. This is either the guild-specific prefix or the default prefix if one is not set.
+	 * @param guild The guild to look up.
+	 * @return The guild-specific prefix for this guild or
+	 */
 	public String getEffectivePrefix(IGuild guild) {
 		return getEffectivePrefix(guild.getLongID());
 	}
 
+	/**
+	 * Gets the prefix for the given guild. This is either the guild-specific prefix or the default prefix if one is not set.
+	 * @param id The id of the guild to look up.
+	 * @return The guild-specific prefix for this guild or
+	 */
 	public String getEffectivePrefix(long id) {
 		return getPrefixForGuild(id).orElse(defaultPrefix);
 	}

src/main/java/com/darichey/discord/limiter/ChannelLimiter.java

@@ -3,6 +3,9 @@
 import com.darichey.discord.CommandContext;
 import sx.blah.discord.handle.obj.IChannel;
 
+/**
+ * Limits execution of a command to a set of channels.
+ */
 public class ChannelLimiter extends IDLimiter {
 
 	public ChannelLimiter(IChannel... channels) {

src/main/java/com/darichey/discord/limiter/GuildLimiter.java

@@ -3,6 +3,9 @@
 import com.darichey.discord.CommandContext;
 import sx.blah.discord.handle.obj.IGuild;
 
+/**
+ * Limits execution of a command to a set of guilds.
+ */
 public class GuildLimiter extends IDLimiter {
 
 	public GuildLimiter(IGuild... guilds) {

src/main/java/com/darichey/discord/limiter/IDLimiter.java

@@ -6,6 +6,9 @@
 
 import java.util.Arrays;
 
+/**
+ * A limiter that limits execution to a set of IDs.
+ */
 public abstract class IDLimiter implements Limiter {
 
 	private final long[] ids;
@@ -23,5 +26,10 @@ public boolean check(CommandContext ctx) {
 		return ArrayUtils.contains(ids, getID(ctx));
 	}
 
+	/**
+	 * Gets the ID to check for this limiter. If the ID returned by this method is not in {@link #ids}, the check will not pass.
+	 * @param ctx The context to get the ID from.
+	 * @return The ID to check for this limiter.
+	 */
 	public abstract long getID(CommandContext ctx);
 }

src/main/java/com/darichey/discord/limiter/Limiter.java

@@ -2,11 +2,23 @@
 
 import com.darichey.discord.CommandContext;
 
+/**
+ * Used to limit the execution of a command to a certain context.
+ */
 @FunctionalInterface
 public interface Limiter {
 
+	/**
+	 * Determines if the command can be executed in the given context.
+	 * @param ctx The context in which the command was executed.
+	 * @return True if the command can be executed.
+	 */
 	boolean check(CommandContext ctx);
 
+	/**
+	 * Executed by the {@link com.darichey.discord.CommandRegistry} if a command is called and {@link #check(CommandContext)} returns false.
+	 * @param ctx The context in which the limiter failed.
+	 */
 	default void onFail(CommandContext ctx) {
 		// NO-OP
 	}

src/main/java/com/darichey/discord/limiter/RoleLimiter.java

@@ -7,6 +7,9 @@
 
 import java.util.Arrays;
 
+/**
+ * Limits execution of a command to a user with <b>ALL</b> of the given roles.
+ */
 public class RoleLimiter implements Limiter {
 
 	private final long[] ids;