Package com.github.rainestormee.jdacommand

Interface AbstractCommand<T>

All Superinterfaces:

java.lang.Comparable<AbstractCommand<T>>

public interface AbstractCommand<T>
extends java.lang.Comparable<AbstractCommand<T>>

This represents a generic command.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
default int	compareTo(AbstractCommand<T> that)
void	execute(T message, java.lang.String args)	Execute this command.
default java.lang.String	getAttribute(java.lang.String key)	Returns the String that the given CommandAttribute contains.
default CommandAttribute[]	getAttributes()	Return the CommandAttributes that are contained within the CommandDescription annotator
default CommandDescription	getDescription()	Get the CommandDescription that annotates this AbstractCommand
default boolean	hasAttribute(java.lang.String key)	Returns if the CommandDescription contains a CommandAttribute with the given key.

Method Detail

execute

void execute(T message,
             java.lang.String args)

Execute this command.

Parameters:

message - T is the object that is passed to this command

args - The arguments from the command

Since:

1.1.3

getDescription

default CommandDescription getDescription()

Get the CommandDescription that annotates this AbstractCommand

Returns:

The CommandDescription

Since:

1.1.3

getAttributes

default CommandAttribute[] getAttributes()

Return the CommandAttributes that are contained within the CommandDescription annotator

Returns:

The CommandAttributes

Since:

1.1.3

hasAttribute

default boolean hasAttribute(java.lang.String key)

Returns if the CommandDescription contains a CommandAttribute with the given key.

Parameters:

key - The key to check the CommandAttribute against.

Returns:

If the relevant CommandAttribute exists

Since:

1.1.3

getAttribute

default java.lang.String getAttribute(java.lang.String key)

Returns the String that the given CommandAttribute contains.

Parameters:

key - The key to get the CommandAttribute of.

Returns:

The relevant String

Since:

1.1.3

compareTo

default int compareTo(AbstractCommand<T> that)

Specified by:

compareTo in interface java.lang.Comparable<T>