Package kboyle.oktane.core.module

Class CommandModule

java.lang.Object

kboyle.oktane.core.module.CommandModule

public final class CommandModule
extends Object

Represents a command module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandModule.Builder

Field Summary

Fields

Modifier and Type	Field	Description
com.google.common.collect.ImmutableList<Class<?>>	beans
com.google.common.collect.ImmutableList<CommandModule>	children
com.google.common.collect.ImmutableList<Command>	commands
Optional<String>	description
com.google.common.collect.ImmutableSet<String>	groups
String	name
Optional<Class<? extends ModuleBase<?>>>	originalClass
Optional<CommandModule>	parent
com.google.common.collect.ImmutableList<Precondition>	preconditions
boolean	singleton
boolean	synchronised

Method Summary

Modifier and Type	Method	Description
static CommandModule.Builder	builder()
reactor.core.publisher.Mono<PreconditionResult>	runPreconditions(CommandContext context, Command command)	Runs the preconditions that belong to this module.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

name

public final String name

groups

public final com.google.common.collect.ImmutableSet<String> groups

commands

public final com.google.common.collect.ImmutableList<Command> commands

preconditions

public final com.google.common.collect.ImmutableList<Precondition> preconditions

description

public final Optional<String> description

beans

public final com.google.common.collect.ImmutableList<Class<?>> beans

singleton

public final boolean singleton

synchronised

public final boolean synchronised

parent

public final Optional<CommandModule> parent

children

public final com.google.common.collect.ImmutableList<CommandModule> children

originalClass

public final Optional<Class<? extends ModuleBase<?>>> originalClass

Method Details

builder

public static CommandModule.Builder builder()

runPreconditions

public reactor.core.publisher.Mono<PreconditionResult> runPreconditions(CommandContext context,
 Command command)

Runs the preconditions that belong to this module.

Parameters:

context - The context to pass to the preconditions.

Returns:

The result of executing the preconditions.

toString

public String toString()

Overrides:

toString in class Object