Package com.hypixel.hytale.protocol.io

Record Class ValidationResult

java.lang.Object
java.lang.Record
com.hypixel.hytale.protocol.io.ValidationResult
public record ValidationResult(boolean isValid, @Nullable String error) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final String
    error
    The field for the error record component.
    private final boolean
    isValid
    The field for the isValid record component.
    static final ValidationResult
    OK
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidationResult(boolean isValid, String error)
    Creates an instance of a ValidationResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    error()
    Returns the value of the error record component.
    static ValidationResult
    error(String message)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isValid()
    Returns the value of the isValid record component.
    void
    throwIfInvalid()
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • isValid

      private final boolean isValid
      The field for the isValid record component.

    • error

      @Nullable private final String error
      The field for the error record component.

    • OK

      public static final ValidationResult OK

  • Constructor Details

    • ValidationResult

      public ValidationResult(boolean isValid, @Nullable String error)
      Creates an instance of a ValidationResult record class.
      Parameters:
      isValid - the value for the isValid record component
      error - the value for the error record component

  • Method Details

    • error

      @Nonnull public static ValidationResult error(@Nonnull String message)

    • throwIfInvalid

      public void throwIfInvalid()

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

    • isValid

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

    • error

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