Package studio.mevera.imperat.command.tree

Class TreeExecutionResult<S extends CommandSource>

java.lang.Object

studio.mevera.imperat.command.tree.TreeExecutionResult<S>

Type Parameters:

S - the source type

public final class TreeExecutionResult<S extends CommandSource>
extends Object

Represents the result of a direct tree execution. This replaces the old CommandPathSearch by combining the search and execution into a single step.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TreeExecutionResult.Status	The status of a tree execution.

Method Summary

Modifier and Type	Method	Description
@NotNull CommandPathway<S>	getClosestUsage()
@Nullable PermissionHolder	getDeniedPermissionHolder()
@Nullable ExecutionContext<S>	getExecutionContext()
@NotNull Command<S>	getLastCommand()
@Nullable CommandPathway<S>	getMatchedPathway()
@NotNull List<ParseResult<S>>	getParsedArguments()
@NotNull TreeExecutionResult.Status	getStatus()
boolean	isSuccess()
static <S extends CommandSource> TreeExecutionResult<S>	noMatch(@Nullable CommandPathway<S> closestUsage, @NotNull Command<S> lastCommand)	Creates a result indicating no matching pathway was found.
static <S extends CommandSource> TreeExecutionResult<S>	permissionDenied(@Nullable CommandPathway<S> closestUsage, @Nullable PermissionHolder deniedPermissionHolder, @NotNull Command<S> lastCommand)	Creates a result indicating permission was denied.
static <S extends CommandSource> TreeExecutionResult<S>	success(@NotNull ExecutionContext<S> executionContext, @NotNull CommandPathway<S> closestUsage, @NotNull CommandPathway<S> matchedPathway, @NotNull Command<S> lastCommand, @NotNull List<ParseResult<S>> parsedArguments)	Creates a successful execution result.

Methods inherited from class java.lang.Object

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

Method Details

success

public static <S extends CommandSource>
TreeExecutionResult<S> success(@NotNull
 @NotNull ExecutionContext<S> executionContext,
 @NotNull
 @NotNull CommandPathway<S> closestUsage,
 @NotNull
 @NotNull CommandPathway<S> matchedPathway,
 @NotNull
 @NotNull Command<S> lastCommand,
 @NotNull
 @NotNull List<ParseResult<S>> parsedArguments)

Creates a successful execution result.

permissionDenied

public static <S extends CommandSource>
TreeExecutionResult<S> permissionDenied(@Nullable
 @Nullable CommandPathway<S> closestUsage,
 @Nullable
 @Nullable PermissionHolder deniedPermissionHolder,
 @NotNull
 @NotNull Command<S> lastCommand)

Creates a result indicating permission was denied.

noMatch

public static <S extends CommandSource>
TreeExecutionResult<S> noMatch(@Nullable
 @Nullable CommandPathway<S> closestUsage,
 @NotNull
 @NotNull Command<S> lastCommand)

Creates a result indicating no matching pathway was found.

getStatus

@NotNull
public @NotNull TreeExecutionResult.Status getStatus()

getExecutionContext

@Nullable
public @Nullable ExecutionContext<S> getExecutionContext()

getMatchedPathway

@Nullable
public @Nullable CommandPathway<S> getMatchedPathway()

getClosestUsage

@NotNull
public @NotNull CommandPathway<S> getClosestUsage()

getDeniedPermissionHolder

@Nullable
public @Nullable PermissionHolder getDeniedPermissionHolder()

getLastCommand

@NotNull
public @NotNull Command<S> getLastCommand()

getParsedArguments

@NotNull
public @NotNull List<ParseResult<S>> getParsedArguments()

isSuccess

public boolean isSuccess()