Package kboyle.oktane.core.module

Class ModuleBase<CONTEXT extends CommandContext>

java.lang.Object

kboyle.oktane.core.module.ModuleBase<CONTEXT>

Type Parameters:

CONTEXT - The type of CommandContext to use.

Direct Known Subclasses:

DiscordModuleBase, ErrorModule, ExampleModuleBase, GeneratedBenchmarkModule, GroupModule, HelpModule

public abstract class ModuleBase<CONTEXT extends CommandContext>
extends Object

Represents a base class to designate a class as a CommandModule.

Constructor Summary

Constructors

Constructor	Description
ModuleBase()

Method Summary

Modifier and Type	Method	Description
protected CONTEXT	context()
protected CommandResult	exception(Exception ex)
protected CommandResult	message(String message)
protected CommandResult	nop()

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleBase

public ModuleBase()

Method Details

context

protected CONTEXT context()

Returns:

The current execution CommandContext.

message

protected CommandResult message(String message)

Parameters:

message - The message to return.

Returns:

A CommandResult representing a simple message.

nop

protected CommandResult nop()

Returns:

A CommandResult representing that no-operation has happened.

exception

protected CommandResult exception(Exception ex)

Parameters:

ex - An Exception that has occurred.

Returns:

A CommandResult representing that an exception occurred.