Package kboyle.oktane.core

Enum Class CommandUtils

java.lang.Object

java.lang.Enum<CommandUtils>

kboyle.oktane.core.CommandUtils

All Implemented Interfaces:

Serializable, Comparable<CommandUtils>, Constable

public enum CommandUtils
extends Enum<CommandUtils>

Utilities for commands.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and Type	Method	Description
static Stream<CommandModule>	flattenModule(CommandModule module)	Gets a CommandModule and all its children.
static reactor.core.publisher.Mono<PreconditionResult>	runParameterPreconditions(CommandContext context, Command command)	Runs the Preconditions for the parameters of the given Command.
static reactor.core.publisher.Mono<PreconditionResult>	runPreconditions(CommandContext context, Command command, com.google.common.collect.ImmutableList<Precondition> preconditions)	Runs the given Preconditions.
static CommandUtils	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommandUtils[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

values

public static CommandUtils[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CommandUtils valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

runPreconditions

public static reactor.core.publisher.Mono<PreconditionResult> runPreconditions(CommandContext context,
 Command command,
 com.google.common.collect.ImmutableList<Precondition> preconditions)

Runs the given Preconditions.

Parameters:

context - The context to pass to Precondition.run(CommandContext, Command).

command - The command to pass to Precondition.run(CommandContext, Command).

preconditions - The Precondition to run.

Returns:

The result of running all of the preconditions.

runParameterPreconditions

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

Runs the Preconditions for the parameters of the given Command.

Parameters:

context - The context to pass to Precondition.run(CommandContext, Command).

command - The command to pass to Precondition.run(CommandContext, Command).

Returns:

The result of running all of the preconditions.

flattenModule

public static Stream<CommandModule> flattenModule(CommandModule module)

Gets a CommandModule and all its children.

Parameters:

module - The CommandModule to get it and all its children from.

Returns:

The given CommandModule and all its children.