Package cloud.commandframework.arguments.parser

Class ArgumentParseResult<T>

java.lang.Object
cloud.commandframework.arguments.parser.ArgumentParseResult<T>
Type Parameters:
T - Parser return type
@API(status=STABLE) public abstract class ArgumentParseResult<T> extends Object
Result of the parsing done by a ArgumentParser

  • Method Details

    • failure

      public static <T> @NonNull ArgumentParseResult<T> failure(@NonNull Throwable failure)
      Indicate that the parsing failed
      Type Parameters:
      T - Parser return type
      Parameters:
      failure - Failure reason
      Returns:
      Failed parse result

    • success

      public static <T> @NonNull ArgumentParseResult<T> success(@NonNull T value)
      Indicate that the parsing succeeded
      Type Parameters:
      T - Parser return type
      Parameters:
      value - Value produced by the parser
      Returns:
      Succeeded parse result

    • getParsedValue

      public abstract @NonNull Optional<T> getParsedValue()
      Get the parsed value, if it exists
      Returns:
      Optional containing the parsed value

    • mapParsedValue

      @API(status=STABLE, since="1.5.0") public abstract <U> @NonNull ArgumentParseResult<U> mapParsedValue(Function<T,U> mapper)
      If this result is successful, transform the output value.
      Type Parameters:
      U - the result type
      Parameters:
      mapper - the transformation
      Returns:
      a new result if successful, otherwise a failure
      Since:
      1.5.0

    • flatMapParsedValue

      @API(status=STABLE, since="1.5.0") public abstract <U> @NonNull ArgumentParseResult<U> flatMapParsedValue(Function<T,ArgumentParseResult<U>> mapper)
      If this result is successful, transform the output value, returning another parse result.
      Type Parameters:
      U - the result type
      Parameters:
      mapper - the transformation
      Returns:
      a new result if successful, otherwise a failure
      Since:
      1.5.0

    • getFailure

      public abstract @NonNull Optional<Throwable> getFailure()
      Get the failure reason, if it exists
      Returns:
      Optional containing the failure reason

    • mapFailure

      @API(status=STABLE, since="1.5.0") public abstract @NonNull ArgumentParseResult<T> mapFailure(Function<Throwable,Throwable> mapper)
      If this result is a failure, transform the exception.
      Parameters:
      mapper - the exception transformation
      Returns:
      if this is a failure, a transformed result, otherwise this
      Since:
      1.5.0