BotCommands-core/io.github.freya022.botcommands.api.commands/CommandPath

CommandPath

interface CommandPath : Comparable<CommandPath> (source)

Represents a path of a command, each path component is delimited with a space, it is the same representation as JDA commands paths given in getFullCommandName. The different components are name, group and subcommand. This is mainly a utility class to avoid manipulating strings

Functions

compareTo

open fun compareTo(@NotNull o: @NotNull CommandPath): Int

equals

abstract fun equals(o: Any): Boolean

Indicates if this command path is equal to another object

getFullPath

@NotNull

abstract fun getFullPath(): @NotNull String

Returns the full encoded path of this command path Each path component is joined with a space delimiter For a slash command such as /show me something, this would be show me something

@NotNull

abstract fun getFullPath(separator: Char): @NotNull String

Returns the full path with the specified separator.

getGroup

@Nullable

abstract fun getGroup(): @Nullable String

Returns the subcommand group name of this command path For a slash command such as /show me something, this would be me

getLastName

@NotNull

abstract fun getLastName(): @NotNull String

Returns the right-most name of this command path For a slash command such as /show me something, this would be something

getName

@NotNull

abstract fun getName(): @NotNull String

Returns the top level name of this command path For a slash command such as /show me something, this would be show

getNameAt

@Nullable

abstract fun getNameAt(i: Int): @Nullable String

Return the name at the i index

getNameCount

abstract fun getNameCount(): Int

Returns the number of path components of this command path For a slash command such as /show me something, this would be 3For a slash command such as /tag info, this would be 2For a slash command such as /say, this would be 1

getParent

@Nullable

abstract fun getParent(): @Nullable CommandPath

Returns the parent path of this command path For a slash command such as /show me something, this would be /show meFor a slash command such as /tag info, this would be /tagFor a slash command such as /say, this would be null

getSubname

@Nullable

abstract fun getSubname(): @Nullable String

Returns the subcommand name of this command path For a slash command such as /show me something, this would be somethingFor a slash command such as /tag info, this would be info

@NotNull

open fun of(@NotNull path: @NotNull String): @NotNull CommandPath

@NotNull

open fun of(@NotNull components: @NotNull Array<@NotNull String>): @NotNull CommandPath

@NotNull

open fun of(@NotNull components: @NotNull List<@NotNull String>): @NotNull CommandPath

@NotNull

open fun of(@NotNull name: @NotNull String, @Nullable subname: @Nullable String): @NotNull CommandPath

@NotNull

open fun of(@NotNull name: @NotNull String, @Nullable group: @Nullable String, @Nullable subname: @Nullable String): @NotNull CommandPath

ofName

@NotNull

open fun ofName(@NotNull name: @NotNull String): @NotNull CommandPath

startsWith

abstract fun startsWith(o: CommandPath): Boolean

Returns whether this command path starts with the supplied command path For example /show me something starts with /show me

toString

@NotNull

abstract fun toString(): @NotNull String

Returns the JDA path representation of this CommandPath