kbrig-core/org.anvilpowered.kbrig.tree/CommandNode

CommandNode

abstract class CommandNode<S>(val name: String, val command: Command<S>?, val requirement: (S) -> Boolean, val redirect: CommandNode<S>?, val forks: Boolean, val children: Map<String, CommandNode<S>>) : Comparable<CommandNode<S>>

Inheritors

ArgumentCommandNode

LiteralCommandNode

RootCommandNode

Constructors

constructor(name: String, command: Command<S>?, requirement: (S) -> Boolean, redirect: CommandNode<S>?, forks: Boolean, children: Map<String, CommandNode<S>>)

Properties

val children: Map<String, CommandNode<S>>

val command: Command<S>?

abstract val examples: Set<String>

val forks: Boolean

val name: String

val redirect: CommandNode<S>?

val requirement: (S) -> Boolean

abstract val usageText: String

Functions

open operator override fun compareTo(other: CommandNode<S>): Int

open operator override fun equals(other: Any?): Boolean

getRelevantNodes

fun getRelevantNodes(input: StringReader): Collection<CommandNode<S>>

open override fun hashCode(): Int

listSuggestions

abstract suspend fun listSuggestions(context: CommandContext<S>, builder: SuggestionsBuilder): Suggestions

fun <S, R> CommandNode<S>.mapSource(mapper: (R) -> S): CommandNode<R>

Converts the given CommandNode with source type S to an CommandNode with source type R.

abstract fun toBuilder(): ArgumentBuilder<S, *>

abstract override fun toString(): String