com.jagrosh.jdautilities.command

Class Command.Category

java.lang.Object

com.jagrosh.jdautilities.command.Command.Category

Enclosing class:

Command

public static class Command.Category
extends java.lang.Object

To be used in Commands as a means of organizing commands into "Categories" as well as terminate command usage when the calling CommandEvent doesn't meet certain requirements.

Author:

John Grosh (jagrosh)

Constructor Summary

Constructors

Constructor and Description
Category(java.lang.String name) A Command Category containing a name.
Category(java.lang.String name, java.util.function.Predicate<CommandEvent> predicate) A Command Category containing a name and a Predicate.
Category(java.lang.String name, java.lang.String failResponse, java.util.function.Predicate<CommandEvent> predicate) A Command Category containing a name, a Predicate, and a failure response.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getFailureResponse() Gets the failure response of the Category.
java.lang.String	getName() Gets the name of the Category.
int	hashCode()
boolean	test(CommandEvent event) Runs a test of the provided Predicate.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Category

public Category(java.lang.String name)

A Command Category containing a name.

Parameters:

name - The name of the Category

Category

public Category(java.lang.String name,
                java.util.function.Predicate<CommandEvent> predicate)

A Command Category containing a name and a Predicate.

The command will be terminated if test(com.jagrosh.jdautilities.command.CommandEvent) returns false.

Parameters:

name - The name of the Category

predicate - The Category predicate to test

Category

public Category(java.lang.String name,
                java.lang.String failResponse,
                java.util.function.Predicate<CommandEvent> predicate)

A Command Category containing a name, a Predicate, and a failure response.

The command will be terminated if test(com.jagrosh.jdautilities.command.CommandEvent) returns false, and the failure response will be sent.

Parameters:

name - The name of the Category

failResponse - The response if the test fails

predicate - The Category predicate to test

Method Detail

getName

public java.lang.String getName()

Gets the name of the Category.

Returns:

The name of the Category

getFailureResponse

public java.lang.String getFailureResponse()

Gets the failure response of the Category.

Returns:

The failure response of the Category

test

public boolean test(CommandEvent event)

Runs a test of the provided Predicate.

Parameters:

event - The CommandEvent that was called when this method is invoked

Returns:

true if the Predicate was not set, was set as null, or was tested and returned true, otherwise returns false

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object