Package kboyle.oktane.core

Class CommandHandler<CONTEXT extends CommandContext>

java.lang.Object

kboyle.oktane.core.CommandHandler<CONTEXT>

Type Parameters:

CONTEXT - The type of context that's used in commands.

public class CommandHandler<CONTEXT extends CommandContext>
extends Object

The entry point for executing commands. CommandHandler.<YourContextType>builder() .withModule(YourCommandModule.class) .build();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandHandler.Builder<CONTEXT extends CommandContext>	A builder for the CommandHandler.

Method Summary

Modifier and Type	Method	Description
static <CONTEXT extends CommandContext> CommandHandler.Builder<CONTEXT>	builder()	Creates a new builder for the CommandHandler.
Stream<Command>	commands()
reactor.core.publisher.Mono<Result>	execute(String input, CONTEXT context)	Tries to execute a command for the given input, checking whether or not the input starts with a prefix.
reactor.core.publisher.Mono<Result>	execute(String input, CONTEXT context, int startIndex)	Tries to execute a command for the given input at the given index (does not check for prefixes).
Stream<CommandModule>	flattenModules()
com.google.common.collect.ImmutableList<CommandModule>	modules()
PrefixHandler	prefixHandler()	Gets the PrefixHandler that this CommandHandler is using.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static <CONTEXT extends CommandContext>
CommandHandler.Builder<CONTEXT> builder()

Creates a new builder for the CommandHandler.

Returns:

A new CommandHandler.Builder.

execute

public reactor.core.publisher.Mono<Result> execute(String input,
 CONTEXT context)

Tries to execute a command for the given input, checking whether or not the input starts with a prefix.

Parameters:

input - The user input to parse.

context - The CommandContext to pass into execution.

Returns:

The result of execution.

Throws:

NullPointerException - when input is null.

NullPointerException - when context is null.

execute

public reactor.core.publisher.Mono<Result> execute(String input,
 CONTEXT context,
 int startIndex)

Tries to execute a command for the given input at the given index (does not check for prefixes).

Parameters:

input - The user input to parse.

context - The CommandContext to pass into execution.

startIndex - The index to start parsing the input from.

Returns:

The result of execution.

Throws:

NullPointerException - when input is null.

NullPointerException - when context is null.

IllegalStateException - when startIndex < 0.

IllegalStateException - when startIndex > input.length().

modules

public com.google.common.collect.ImmutableList<CommandModule> modules()

Returns:

All of the top level CommandModules that belong to the CommandHandler.

flattenModules

public Stream<CommandModule> flattenModules()

Returns:

Recursively gets all top level CommandModules and their children that belong to the CommandHandler.

commands

public Stream<Command> commands()

Returns:

All of the Commands that belong to the CommandHandler.

prefixHandler

public PrefixHandler prefixHandler()

Gets the PrefixHandler that this CommandHandler is using.

Returns:

The PrefixHandler.