Class DefaultCommandProvider

java.lang.Object

eu.cloudnetservice.node.impl.command.defaults.DefaultCommandProvider

All Implemented Interfaces:

eu.cloudnetservice.node.command.CommandProvider

@Singleton
@Provides(eu.cloudnetservice.node.command.CommandProvider.class)
public final class DefaultCommandProvider
extends Object
implements eu.cloudnetservice.node.command.CommandProvider

Default implementation of the command provider.

Field Summary

Fields

Modifier and Type	Field	Description
private static final CloudKey<Set<String>>	ALIAS_KEY
private final org.incendo.cloud.annotations.AnnotationParser<eu.cloudnetservice.node.command.source.CommandSource>	annotationParser
private final CommandManager<eu.cloudnetservice.node.command.source.CommandSource>	commandManager
private static final CloudKey<String>	DESCRIPTION_KEY
private static final CloudKey<String>	DOCUMENTATION_KEY
private final CommandExceptionHandler	exceptionHandler
private final eu.cloudnetservice.driver.language.I18n	i18n
private final com.google.common.collect.SetMultimap<ClassLoader, eu.cloudnetservice.driver.command.CommandInfo>	registeredCommands
private static final CloudKey<String>	SKIP_CONFIRMATION_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultCommandProvider(@NonNull eu.cloudnetservice.driver.language.I18n i18n, @NonNull DefaultCommandManager commandManager, @NonNull AerogelInjectionService injectionService, @NonNull CommandExceptionHandler exceptionHandler, @NonNull DefaultSuggestionProcessor suggestionProcessor, @NonNull DefaultCommandPreProcessor commandPreProcessor, @NonNull DefaultCommandPostProcessor commandPostProcessor, @NonNull DefaultCaptionHandler captionHandler)

Method Summary

Modifier and Type	Method	Description
@Nullable eu.cloudnetservice.driver.command.CommandInfo	command(@NonNull String name)
@NonNull Collection<eu.cloudnetservice.driver.command.CommandInfo>	commands()
private @NonNull List<String>	commandUsageOfRoot(@NonNull String root)	Parses the command usage by the given root command.
@NonNull CompletableFuture<?>	execute(@NonNull eu.cloudnetservice.node.command.source.CommandSource source, @NonNull String input)
void	register(@NonNull Class<?> commandClass)
void	register(@NonNull Object command)
private void	registerCommandConfirmation()	Registers the default confirmation handling for commands, that need a confirmation before they are executed.
void	registerConsoleHandler(@NonNull Console console)
void	registerDefaultCommands()
@NonNull List<String>	suggest(@NonNull eu.cloudnetservice.node.command.source.CommandSource source, @NonNull String input)
void	unregister(@NonNull ClassLoader classLoader)
void	unregister(@NonNull String name)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALIAS_KEY

private static final CloudKey<Set<String>> ALIAS_KEY

DESCRIPTION_KEY

private static final CloudKey<String> DESCRIPTION_KEY

DOCUMENTATION_KEY

private static final CloudKey<String> DOCUMENTATION_KEY

SKIP_CONFIRMATION_KEY

private static final CloudKey<String> SKIP_CONFIRMATION_KEY

i18n

private final eu.cloudnetservice.driver.language.I18n i18n

exceptionHandler

private final CommandExceptionHandler exceptionHandler

commandManager

private final CommandManager<eu.cloudnetservice.node.command.source.CommandSource> commandManager

annotationParser

private final org.incendo.cloud.annotations.AnnotationParser<eu.cloudnetservice.node.command.source.CommandSource> annotationParser

registeredCommands

private final com.google.common.collect.SetMultimap<ClassLoader, eu.cloudnetservice.driver.command.CommandInfo> registeredCommands

Constructor Details

DefaultCommandProvider

@Inject
private DefaultCommandProvider(@NonNull @Service
 @NonNull eu.cloudnetservice.driver.language.I18n i18n,
 @NonNull
 @NonNull DefaultCommandManager commandManager,
 @NonNull
 @NonNull AerogelInjectionService injectionService,
 @NonNull
 @NonNull CommandExceptionHandler exceptionHandler,
 @NonNull
 @NonNull DefaultSuggestionProcessor suggestionProcessor,
 @NonNull
 @NonNull DefaultCommandPreProcessor commandPreProcessor,
 @NonNull
 @NonNull DefaultCommandPostProcessor commandPostProcessor,
 @NonNull
 @NonNull DefaultCaptionHandler captionHandler)

Method Details

suggest

@NonNull
public @NonNull List<String> suggest(@NonNull
 @NonNull eu.cloudnetservice.node.command.source.CommandSource source,
 @NonNull
 @NonNull String input)

Specified by:

suggest in interface eu.cloudnetservice.node.command.CommandProvider

execute

@NonNull
public @NonNull CompletableFuture<?> execute(@NonNull
 @NonNull eu.cloudnetservice.node.command.source.CommandSource source,
 @NonNull
 @NonNull String input)

Specified by:

execute in interface eu.cloudnetservice.node.command.CommandProvider

register

public void register(@NonNull
 @NonNull Class<?> commandClass)

Specified by:

register in interface eu.cloudnetservice.node.command.CommandProvider

register

public void register(@NonNull
 @NonNull Object command)

Specified by:

register in interface eu.cloudnetservice.node.command.CommandProvider

unregister

public void unregister(@NonNull
 @NonNull String name)

Specified by:

unregister in interface eu.cloudnetservice.node.command.CommandProvider

unregister

public void unregister(@NonNull
 @NonNull ClassLoader classLoader)

Specified by:

unregister in interface eu.cloudnetservice.node.command.CommandProvider

registerConsoleHandler

public void registerConsoleHandler(@NonNull
 @NonNull Console console)

registerDefaultCommands

public void registerDefaultCommands()

command

@Nullable
public @Nullable eu.cloudnetservice.driver.command.CommandInfo command(@NonNull
 @NonNull String name)

Specified by:

command in interface eu.cloudnetservice.node.command.CommandProvider

commands

@NonNull
public @NonNull Collection<eu.cloudnetservice.driver.command.CommandInfo> commands()

Specified by:

commands in interface eu.cloudnetservice.node.command.CommandProvider

registerCommandConfirmation

private void registerCommandConfirmation()

Registers the default confirmation handling for commands, that need a confirmation before they are executed.

commandUsageOfRoot

@NonNull
private @NonNull List<String> commandUsageOfRoot(@NonNull
 @NonNull String root)

Parses the command usage by the given root command.

Parameters:

root - the command to parse the usage for.

Returns:

the formatted and sorted usages for the command root.