Record Class TypeParseResult<T>

java.lang.Object
java.lang.Record
dev.ua.theroer.magicutils.commands.TypeParseResult<T>
Type Parameters:
T - parsed value type
Record Components:
status - parse status
value - parsed value
public record TypeParseResult<T>(@NotNull TypeParseResult.Status status, T value) extends Record
Detailed result for command argument parsing.

  • Constructor Details

    • TypeParseResult

      public TypeParseResult(@NotNull @NotNull TypeParseResult.Status status, @Nullable T value)
      Creates an instance of a TypeParseResult record class.
      Parameters:
      status - the value for the status record component
      value - the value for the value record component

  • Method Details

    • success

      public static <T> TypeParseResult<T> success(@Nullable T value)
      Creates a successful parse result.
      Type Parameters:
      T - value type
      Parameters:
      value - parsed value
      Returns:
      success result

    • missing

      public static <T> TypeParseResult<T> missing()
      Creates a missing-value result.
      Type Parameters:
      T - value type
      Returns:
      missing result

    • invalid

      public static <T> TypeParseResult<T> invalid()
      Creates an invalid-value result.
      Type Parameters:
      T - value type
      Returns:
      invalid result

    • isSuccess

      public boolean isSuccess()
      Returns true when parsing succeeded.
      Returns:
      success flag

    • isMissing

      public boolean isMissing()
      Returns true when the input was not provided.
      Returns:
      missing flag

    • isInvalid

      public boolean isInvalid()
      Returns true when the input was provided but invalid.
      Returns:
      invalid flag

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • status

      @NotNull public @NotNull TypeParseResult.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • value

      @Nullable public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component