Package dev.jorel.commandapi.arguments.parser

Record Class Result<T>

java.lang.Object

java.lang.Record

dev.jorel.commandapi.arguments.parser.Result<T>

Type Parameters:

T - The type of object held as a return result.

Record Components:

value - The result of parsing input, if the parse was successful.

exception - The CommandSyntaxException thrown, if the parse failed.

suggestionsStart - The point in the input StringReader where the suggestions should be placed.

suggestions - The SuggestionProvider object that will generate the suggestions.

public record Result<T>(T value, com.mojang.brigadier.exceptions.CommandSyntaxException exception, int suggestionsStart, SuggestionProvider suggestions)
extends Record

Holds the information that results from a Parser parsing input. A parse either creates an object or throws a CommandSyntaxException explaining why it couldn't create its object. The result may optionally provide suggestions, which includes the point in the string where the suggestions should be placed and the SuggestionProvider that will generate the suggestions.

Results can be constructed with the following methods:

• withValue(Object)
• withValueAndSuggestions(Object, int, SuggestionProvider)
• withVoidValue()
• withVoidValueAndSuggestions(int, SuggestionProvider)
• withException(CommandSyntaxException)
• withExceptionAndSuggestions(CommandSyntaxException, int, SuggestionProvider)

Additionally, a Result object with the same value but different suggestions can be created using withSuggestions(int, SuggestionProvider).

The information of a Result can be accessed directly using value(), exception(), suggestionsStart(), or suggestions(). Additionally, the information can be interacted with using throwOrReturn() or continueWith(Function, Function).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Result.ThrowableFunction<T,R>	A FunctionalInterface with abstract method Result.ThrowableFunction.apply(Object).
static class	Result.Void	A placeholder object that represents a successful parse that didn't return a specific object.

Constructor Summary

Constructors

Constructor	Description
Result(T value, com.mojang.brigadier.exceptions.CommandSyntaxException exception, int suggestionsStart, SuggestionProvider suggestions)	Creates an instance of a Result record class.

Method Summary

Modifier and Type	Method	Description
<R> Result<R>	continueWith(Function<T,Result<R>> success)	This method works the same as continueWith(Function, Function), but the failure Function is given as Result::withException.
<R> Result<R>	continueWith(Function<T,Result<R>> success, Function<com.mojang.brigadier.exceptions.CommandSyntaxException,Result<R>> failure)	Uses this Result to generate a final Result with a value of type R.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
com.mojang.brigadier.exceptions.CommandSyntaxException	exception()	Returns the value of the exception record component.
final int	hashCode()	Returns a hash code value for this object.
SuggestionProvider	suggestions()	Returns the value of the suggestions record component.
int	suggestionsStart()	Returns the value of the suggestionsStart record component.
T	throwOrReturn()
final String	toString()	Returns a string representation of this record class.
T	value()	Returns the value of the value record component.
static <T> Result<T>	withException(@NotNull com.mojang.brigadier.exceptions.CommandSyntaxException exception)
static <T> Result<T>	withExceptionAndSuggestions(@NotNull com.mojang.brigadier.exceptions.CommandSyntaxException exception, int suggestionsStart, SuggestionProvider suggestions)
Result<T>	withSuggestions(int suggestionsStart, SuggestionProvider suggestions)	Keeps the same value or exception but overrides any suggestions information.
static <T> Result<T>	withValue(T value)
static <T> Result<T>	withValueAndSuggestions(T value, int suggestionsStart, SuggestionProvider suggestions)
static Result<Result.Void>	withVoidValue()
static Result<Result.Void>	withVoidValueAndSuggestions(int suggestionsStart, SuggestionProvider suggestions)
static <T, R> Function<T,Result<R>>	wrapFunctionResult(Result.ThrowableFunction<T,R> original)	Converts a Result.ThrowableFunction<T, R> into a Function<T, Result<R>>.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Result

public Result(T value,
 com.mojang.brigadier.exceptions.CommandSyntaxException exception,
 int suggestionsStart,
 SuggestionProvider suggestions)

Creates an instance of a Result record class.

Parameters:

value - the value for the value record component

exception - the value for the exception record component

suggestionsStart - the value for the suggestionsStart record component

suggestions - the value for the suggestions record component

Method Details

withValue

public static <T> Result<T> withValue(@NotNull
 T value)

Type Parameters:

T - The type of object held as a return value.

Parameters:

value - The object resulting from parsing input.

Returns:

A new Result object with the given information.

withVoidValue

public static Result<Result.Void> withVoidValue()

Returns:

A new Result with a Result.Void value.

withException

public static <T> Result<T> withException(@NotNull
 @NotNull com.mojang.brigadier.exceptions.CommandSyntaxException exception)

Type Parameters:

T - The type of object held as a return value.

Parameters:

exception - The CommandSyntaxException explaining why a value object could not be created from the given input.

Returns:

A new Result object with the given information.

withValueAndSuggestions

public static <T> Result<T> withValueAndSuggestions(@NotNull
 T value,
 int suggestionsStart,
 SuggestionProvider suggestions)

Type Parameters:

T - The type of object held as a return value.

Parameters:

value - The object resulting from parsing input.

suggestionsStart - The point in the input where suggestions should be placed.

suggestions - The SuggestionProvider object that will generate the suggestions.

Returns:

A new Result object with the given information.

withVoidValueAndSuggestions

public static Result<Result.Void> withVoidValueAndSuggestions(int suggestionsStart,
 SuggestionProvider suggestions)

Parameters:

suggestionsStart - The point in the input where suggestions should be placed.

suggestions - The SuggestionProvider object that will generate the suggestions.

Returns:

A new Result object with a Result.Void value and the given suggestions.

withExceptionAndSuggestions

public static <T> Result<T> withExceptionAndSuggestions(@NotNull
 @NotNull com.mojang.brigadier.exceptions.CommandSyntaxException exception,
 int suggestionsStart,
 SuggestionProvider suggestions)

Type Parameters:

T - The type of object held as a return value.

Parameters:

exception - The CommandSyntaxException explaining why a value object could not be created from the given input.

suggestionsStart - The point in the input where suggestions should be placed.

suggestions - The SuggestionProvider object that will generate the suggestions.

Returns:

A new Result object with the given information.

withSuggestions

public Result<T> withSuggestions(int suggestionsStart,
 SuggestionProvider suggestions)

Keeps the same value or exception but overrides any suggestions information.

Parameters:

suggestionsStart - The point in the input where suggestions should be placed.

suggestions - The SuggestionProvider object that will generate the suggestions.

Returns:

A new Result object with the given information.

throwOrReturn

public T throwOrReturn()
                throws com.mojang.brigadier.exceptions.CommandSyntaxException

Returns:

value() if the parse was successful.

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException - exception() if the parse failed.

continueWith

public <R> Result<R> continueWith(Function<T,Result<R>> success,
 Function<com.mojang.brigadier.exceptions.CommandSyntaxException,Result<R>> failure)

Uses this Result to generate a final Result with a value of type R. If this parse was successful, then the given success Function is used to generate the new Result. If this parse failed, then the given failure Function is used to generate the new Result.

If the new Result does not have any suggestions(), then the final Result returned by this method will have the suggestionsStart() and suggestions() of this Result.

Note that the wrapFunctionResult(ThrowableFunction) method may be useful for defining the success and failure Functions.

Type Parameters:

R - The type of object held as the value() of the final Result.

Parameters:

success - The Function to use to generate the new Result when this parse was successful. The argument passed to Function.apply(Object) will be the value() of this Result.

failure - The Function to use to generate the new Result when this parse failed. The argument passed to Function.apply(Object) will be the exception() of this Result.

Returns:

The final Result object.

continueWith

public <R> Result<R> continueWith(Function<T,Result<R>> success)

This method works the same as continueWith(Function, Function), but the failure Function is given as Result::withException. This has the effect of passing the exception and suggestions of this Result without changes if this parse failed. If this parse succeeded, the success Function is applied as usual.

Type Parameters:

R - The type of object held as the value() of the final Result.

Parameters:

success - The Function to use to generate the new Result when this parse was successful. The argument passed to Function.apply(Object) will be the value() of this Result.

Returns:

The final Result object.

wrapFunctionResult

public static <T,
R> Function<T,Result<R>> wrapFunctionResult(Result.ThrowableFunction<T,R> original)

Converts a Result.ThrowableFunction<T, R> into a Function<T, Result<R>>. The returned Function will pass its argument unchanged to the given Result.ThrowableFunction. The outcome of the Result.ThrowableFunction - either returning an object of type R or throwing a CommandSyntaxException - will be wrapped into a Result<R> as appropriate.

Type Parameters:

T - The type of the function parameter.

R - The function return type.

Parameters:

original - The Result.ThrowableFunction being wrapped.

Returns:

A Function that wraps the outcome of the given Result.ThrowableFunction in a Result.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

value

public T value()

Returns the value of the value record component.

Returns:

the value of the value record component

exception

public com.mojang.brigadier.exceptions.CommandSyntaxException exception()

Returns the value of the exception record component.

Returns:

the value of the exception record component

suggestionsStart

public int suggestionsStart()

Returns the value of the suggestionsStart record component.

Returns:

the value of the suggestionsStart record component

suggestions

public SuggestionProvider suggestions()

Returns the value of the suggestions record component.

Returns:

the value of the suggestions record component