Package org.incendo.cloud.help.result

Interface CommandEntry<C>

All Superinterfaces:

Comparable<CommandEntry<C>>

@Immutable
@API(status=STABLE)
public interface CommandEntry<C>
extends Comparable<CommandEntry<C>>

Method Summary

Modifier and Type	Method	Description
@NonNull Command<C>	command()	Returns the command.
default int	compareTo(@NonNull CommandEntry<C> other)
static <C> @NonNull CommandEntry<C>	of(@NonNull Command<C> command, @NonNull String syntax)	Creates a new command entry.
@NonNull String	syntax()	Returns the command syntax.

Method Details

of

static <C> @NonNull CommandEntry<C> of(@NonNull Command<C> command,
 @NonNull String syntax)

Creates a new command entry.

Type Parameters:

C - the command sender type

Parameters:

command - the command

syntax - the command syntax

Returns:

the created entry

command

@NonNull Command<C> command()

Returns the command.

Returns:

the command

syntax

@NonNull String syntax()

Returns the command syntax.

Returns:

the command syntax

compareTo

default int compareTo(@NonNull CommandEntry<C> other)

Specified by:

compareTo in interface Comparable<C>