Package kboyle.oktane.core

Class CommandHandler.Builder<CONTEXT extends CommandContext>

java.lang.Object

kboyle.oktane.core.CommandHandler.Builder<CONTEXT>

Type Parameters:

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

Enclosing class:

CommandHandler<CONTEXT extends CommandContext>

public static class CommandHandler.Builder<CONTEXT extends CommandContext>
extends Object

A builder for the CommandHandler.

Method Summary

Modifier and Type	Method	Description
CommandHandler.Builder<CONTEXT>	applyConfigurator(CommandHandlerConfigurator configurator)	Applies the given CommandHandlerConfigurator to the CommandHandler.Builder.
CommandHandler<CONTEXT>	build()	Builds the CommandHandler.
CommandHandler.Builder<CONTEXT>	withArgumentParser(ArgumentParser argumentParser)	Sets the ArgumentParser that will be used, if none is specified then the default will be used.
CommandHandler.Builder<CONTEXT>	withBeanProvider(BeanProvider beanProvider)	Adds the BeanProvider that will be used to fetch dependencies for singleton CommandModules.
<MODULE extends ModuleBase<CONTEXT>> CommandHandler.Builder<CONTEXT>	withModule(Class<MODULE> moduleClass)	Adds a CommandModule that will be used by the CommandHandler.
<MODULE extends ModuleBase<CONTEXT>> CommandHandler.Builder<CONTEXT>	withModule(Class<MODULE> moduleClass, Consumer<CommandModule.Builder> builderConsumer)	Adds a CommandModule that will be used by the CommandHandler.
CommandHandler.Builder<CONTEXT>	withModule(Consumer<CommandModule.Builder> builderConsumer)	Adds a CommandModule using only the builders and not from a class.
<MODULE extends ModuleBase<CONTEXT>> CommandHandler.Builder<CONTEXT>	withModules(Class<MODULE> moduleClass)	Adds all the CommandModule's that link in the same package as the moduleClass.
<MODULE extends ModuleBase<CONTEXT>> CommandHandler.Builder<CONTEXT>	withModules(Class<MODULE> moduleClass, Consumer<CommandModule.Builder> builderConsumer)	Adds all the CommandModule's that link in the same package as the moduleClass.
CommandHandler.Builder<CONTEXT>	withPreconditionFactory(PreconditionFactory<?> factory)	Adds a PreconditionFactory that will be used to instantiate preconditions.
CommandHandler.Builder<CONTEXT>	withPrefixHandler(PrefixHandler prefixHandler)	Sets the PrefixHandler that will be used to supply prefixes.
CommandHandler.Builder<CONTEXT>	withTokeniser(Tokeniser tokeniser)	Sets the Tokeniser that will be used, if none is specified then the default will be used.
<TARGET> CommandHandler.Builder<CONTEXT>	withTypeParser(Class<TARGET> cl, TypeParser<TARGET> parser)	Adds a TypeParser that will be used by the CommandHandler.

Methods inherited from class java.lang.Object

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

Method Details

withTypeParser

public <TARGET> CommandHandler.Builder<CONTEXT> withTypeParser(Class<TARGET> cl,
 TypeParser<TARGET> parser)

Adds a TypeParser that will be used by the CommandHandler.

Type Parameters:

TARGET - The type that the TypeParser is for.

Parameters:

cl - The class representing the type that the TypeParser is for.

parser - The TypeParser.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when cl is null.

NullPointerException - when parser is null.

withModule

public CommandHandler.Builder<CONTEXT> withModule(Consumer<CommandModule.Builder> builderConsumer)

Adds a CommandModule using only the builders and not from a class.

Parameters:

builderConsumer - A consumer used to modify the state of the CommandModule.Builder.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when builderConsumer is null.

withModule

public <MODULE extends ModuleBase<CONTEXT>>
CommandHandler.Builder<CONTEXT> withModule(Class<MODULE> moduleClass)

Adds a CommandModule that will be used by the CommandHandler.

Type Parameters:

MODULE - The type of module you want to add.

Parameters:

moduleClass - The class representing the type of module that you want to add.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when moduleClass is null.

withModule

public <MODULE extends ModuleBase<CONTEXT>>
CommandHandler.Builder<CONTEXT> withModule(Class<MODULE> moduleClass,
 Consumer<CommandModule.Builder> builderConsumer)

Adds a CommandModule that will be used by the CommandHandler.

Type Parameters:

MODULE - The type of module you want to add.

Parameters:

moduleClass - The class representing the type of module that you want to add.

builderConsumer - A consumer used to modify the state of the CommandModule.Builder.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when moduleClass is null.

NullPointerException - when builderConsumer is null.

withModules

public <MODULE extends ModuleBase<CONTEXT>>
CommandHandler.Builder<CONTEXT> withModules(Class<MODULE> moduleClass)

Adds all the CommandModule's that link in the same package as the moduleClass. This method is not type safe and will add modules that don't inherit from ModuleBase<CONTEXT>

Parameters:

moduleClass - The module that lives in the same package as your other modules.

Returns:

The CommandHandler.Builder.

Throws:

RuntimeIOException - if the attempt to read class path resources (jar files or directories) failed.

withModules

public <MODULE extends ModuleBase<CONTEXT>>
CommandHandler.Builder<CONTEXT> withModules(Class<MODULE> moduleClass,
 Consumer<CommandModule.Builder> builderConsumer)

Adds all the CommandModule's that link in the same package as the moduleClass. This method is not type safe and will add modules that don't inherit from ModuleBase<CONTEXT>

Parameters:

moduleClass - The module that lives in the same package as your other modules.

builderConsumer - A consumer used to modify the state of the CommandModule.Builder.

Returns:

The CommandHandler.Builder.

Throws:

RuntimeIOException - if the attempt to read class path resources (jar files or directories) failed.

withBeanProvider

public CommandHandler.Builder<CONTEXT> withBeanProvider(BeanProvider beanProvider)

Adds the BeanProvider that will be used to fetch dependencies for singleton CommandModules.

Parameters:

beanProvider - The BeanProvider.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when beanProvider is null.

withArgumentParser

public CommandHandler.Builder<CONTEXT> withArgumentParser(ArgumentParser argumentParser)

Sets the ArgumentParser that will be used, if none is specified then the default will be used.

Parameters:

argumentParser - The ArgumentParser.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when argumentParser is null.

withTokeniser

public CommandHandler.Builder<CONTEXT> withTokeniser(Tokeniser tokeniser)

Sets the Tokeniser that will be used, if none is specified then the default will be used.

Parameters:

tokeniser - The Tokeniser.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when tokeniser is null.

withPreconditionFactory

public CommandHandler.Builder<CONTEXT> withPreconditionFactory(PreconditionFactory<?> factory)

Adds a PreconditionFactory that will be used to instantiate preconditions.

Parameters:

factory - The PreconditionFactory that will be used instead of Precondition of the given type.

Returns:

The CommandHandler.Builder.

Throws:

NullPointerException - when factory is null.

withPrefixHandler

public CommandHandler.Builder<CONTEXT> withPrefixHandler(PrefixHandler prefixHandler)

Sets the PrefixHandler that will be used to supply prefixes.

Parameters:

prefixHandler - The PrefixHandler to use.

Returns:

The CommandHandler.Builder.

applyConfigurator

public CommandHandler.Builder<CONTEXT> applyConfigurator(CommandHandlerConfigurator configurator)

Applies the given CommandHandlerConfigurator to the CommandHandler.Builder.

Parameters:

configurator - The CommandHandlerConfigurator to apply.

Returns:

The CommandHandler.Builder.

build

public CommandHandler<CONTEXT> build()

Builds the CommandHandler.

Returns:

The built CommandHandler.