Package ch.njol.skript.util

Record Class ValidationResult<T>

java.lang.Object
java.lang.Record
ch.njol.skript.util.ValidationResult<T>
Type Parameters:
T - The type of data returned from a successful validation.
Record Components:
valid - Whether the validation was successful.
message - An optional message describing the result.
data - Optional data returned from the validation.
public record ValidationResult<T>(boolean valid, @Nullable String message, T data) extends Record
Represents the result of a validation check.

This record stores whether a check was valid, an optional message explaining the result (i.e., an error or warning message), and optional data returned from the check if it successfully passed.

  • Constructor Details

    • ValidationResult

      public ValidationResult(boolean valid)
      Constructs a ValidationResult with only a validity flag.
      Parameters:
      valid - Whether the validation was successful.

    • ValidationResult

      public ValidationResult(boolean valid, @Nullable @Nullable String message)
      Constructs a ValidationResult with a validity flag and message.
      Parameters:
      valid - Whether the validation was successful.
      message - An optional message describing the result.

    • ValidationResult

      public ValidationResult(boolean valid, @Nullable T data)
      Constructs a ValidationResult with a validity flag and result data.
      Parameters:
      valid - Whether the validation was successful.
      data - Optional data returned from the validation.

    • ValidationResult

      public ValidationResult(boolean valid, @Nullable @Nullable String message, @Nullable T data)
      Constructs a ValidationResult with a validity flag, message and result data.
      Parameters:
      valid - Whether the validation was successful.
      message - An optional message describing the result.
      data - Optional data returned from the validation.

  • Method Details

    • 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.

    • valid

      public boolean valid()
      Returns the value of the valid record component.
      Returns:
      the value of the valid record component

    • message

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

    • data

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