Class CommandInvalidSyntaxEvent

java.lang.Object

eu.cloudnetservice.driver.event.Event

eu.cloudnetservice.node.event.command.CommandInvalidSyntaxEvent

public final class CommandInvalidSyntaxEvent
extends eu.cloudnetservice.driver.event.Event

Field Summary

Fields

Modifier and Type	Field	Description
private final String	correctSyntax
private final List<String>	fullCommandTree
private List<String>	response
private final CommandSource	source

Constructor Summary

Constructors

Constructor	Description
CommandInvalidSyntaxEvent(@NonNull CommandSource source, @NonNull String correctSyntax, @NonNull List<String> fullCommandTree, @NonNull List<String> response)

Method Summary

Modifier and Type	Method	Description
@NonNull CommandSource	commandSource()
@NonNull String	correctSyntax()
@NonNull List<String>	fullCommandTree()	Gets the full command tree for the input that lead to this event.
@NonNull List<String>	response()
void	response(@NonNull List<String> response)	Set the translated invalid syntax message that is the user will receive

Methods inherited from class Object

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

Field Details

source

private final CommandSource source

correctSyntax

private final String correctSyntax

fullCommandTree

private final List<String> fullCommandTree

response

private List<String> response

Constructor Details

CommandInvalidSyntaxEvent

public CommandInvalidSyntaxEvent(@NonNull
 @NonNull CommandSource source,
 @NonNull
 @NonNull String correctSyntax,
 @NonNull
 @NonNull List<String> fullCommandTree,
 @NonNull
 @NonNull List<String> response)

Method Details

commandSource

@NonNull
public @NonNull CommandSource commandSource()

Returns:

the command source that executed the commandline.

correctSyntax

@NonNull
public @NonNull String correctSyntax()

Returns:

the correct syntax for the executed command

fullCommandTree

@NonNull
public @NonNull List<String> fullCommandTree()

Gets the full command tree for the input that lead to this event.

Returns:

the command tree.

response

@NonNull
public @NonNull List<String> response()

Returns:

the translated invalid syntax message that is the user will receive

response

public void response(@NonNull
 @NonNull List<String> response)

Set the translated invalid syntax message that is the user will receive

Parameters:

response - the message that the user will receive