com.shakelang.util.commander/com.shakelang.util.commander

Package-level declarations

Types

CliArgumentInit

typealias CliArgumentInit = CommanderArgumentCreationContext.() -> Unit

Init function for CommanderArgument

CommanderArgument

class CommanderArgument(val command: CommanderCommand, val name: String, val description: String? = null, val required: Boolean = false, val defaultValue: String? = null, val valueName: String? = null, val valueDescription: String? = null, val valueValidator: CommanderValueValidator? = null)

A class representing an argument of a CommanderCommand

CommanderArgumentCreationContext

class CommanderArgumentCreationContext

A class representing a context for creating a CommanderArgument

CommanderCommand

class CommanderCommand(val parent: CommanderCommand? = null, val name: String, val aliases: Array<String> = arrayOf(), val description: String? = null, val arguments: MutableList<CommanderArgument> = mutableListOf(), val options: MutableList<CommanderOption> = mutableListOf(), val commands: MutableList<CommanderCommand> = mutableListOf(), var action: CommanderCommandAction? = null)

A class that represents a command line interface command

CommanderCommandAction

typealias CommanderCommandAction = CommanderCommand.(CommanderParseResult) -> Unit

A typealias that represents a cli command action

CommanderCommandCreationContext

class CommanderCommandCreationContext

Context for creating a command

CommanderCommandInit

typealias CommanderCommandInit = CommanderCommandCreationContext.() -> Unit

Init function for creating a command

CommanderCommandStackEntry

open class CommanderCommandStackEntry(val alias: String, val command: CommanderCommand, val arguments: Map<String, CommanderValue>, val options: Map<String, Array<CommanderValue>>)

A stack entry

CommanderException

open class CommanderException(message: String) : RuntimeException

Base class for all exceptions thrown by the commander

CommanderMissingArgumentException

class CommanderMissingArgumentException(message: String) : CommanderException

Error thrown when a required argument is missing

CommanderMissingOptionException

class CommanderMissingOptionException(message: String) : CommanderException

Error thrown when a required option is missing

CommanderMissingOptionValueException

class CommanderMissingOptionValueException(message: String) : CommanderException

Error thrown when an option is missing a value

CommanderMutableCommandStackEntry

class CommanderMutableCommandStackEntry(val alias: String, val command: CommanderCommand) : CommanderCommandStackEntry

A mutable stack entry

CommanderOption

class CommanderOption(val command: CommanderCommand, val name: String, val aliases: Array<String> = arrayOf(), val shortAlias: Array<String> = arrayOf(), val description: String? = null, val required: Boolean = false, val hasValue: Boolean = false, val defaultValue: String? = null, val valueName: String? = null, val valueDescription: String? = null, val valueValidator: CommanderValueValidator? = null)

A class representing a command line option

CommanderOptionCreationContext

class CommanderOptionCreationContext

A class representing a context for creating a CommanderOption

CommanderOptionInit

typealias CommanderOptionInit = CommanderOptionCreationContext.() -> Unit

Init function for CommanderOption

CommanderParseResult

class CommanderParseResult(val stack: List<CommanderCommandStackEntry>)

The result of a parse operation

CommanderSyntaxException

open class CommanderSyntaxException(message: String) : CommanderException

Error thrown in runtime when the syntax of the command is not valid

CommanderUnknownArgumentException

class CommanderUnknownArgumentException(message: String) : CommanderException

Error thrown when an argument is passed, but not expected

CommanderUnknownOptionException

class CommanderUnknownOptionException(message: String) : CommanderException

Error thrown when a non-existing option is passed

CommanderUnknownSubCommandException

class CommanderUnknownSubCommandException(message: String) : CommanderException

Error thrown when a sub-command is passed, but not expected

data class CommanderValue(val value: String?)

A wrapper for a string-encoded value

CommanderValueException

open class CommanderValueException(message: String) : CommanderException

Base class for exceptions thrown when a value is not valid

CommanderValueTransformer

interface CommanderValueTransformer<T>

A transformer for a string-encoded value

CommanderValueTransformerLambda

typealias CommanderValueTransformerLambda<T> = (String?) -> T

A transformer lambda for a string-encoded value

CommanderValueTransformers

object CommanderValueTransformers

A collection of common CommanderValueTransformer implementations

CommanderValueValidator

interface CommanderValueValidator

A validator for a string-encoded value

CommanderValueValidatorLambda

typealias CommanderValueValidatorLambda = (String?) -> Unit

A validator lambda for a string-encoded value

CommanderValueValidators

object CommanderValueValidators

A collection of common CommanderValueValidator implementations

ValueValidationException

class ValueValidationException(message: String) : CommanderValueException

Error thrown when an argument is not valid

Functions

fun command(init: CommanderCommandInit): CommanderCommand

Create a new command

valueTransformer

fun <T> valueTransformer(transformer: CommanderValueTransformerLambda<T>): CommanderValueTransformer<T>

Create a new CommanderValueTransformer from a lambda

fun valueValidator(validator: CommanderValueValidatorLambda): CommanderValueValidator

Create a new CommanderValueValidator from a lambda