Record Class ValidationResult

java.lang.Object
java.lang.Record
com.loomcache.server.config.ValidationResult
Record Components:
valid - whether the value is valid
errorMessage - optional error message (null if valid)
public record ValidationResult(boolean valid, @Nullable String errorMessage) extends Record
Immutable validation result for configuration values.

  • Constructor Details

    • ValidationResult

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

  • Method Details

    • success

      public static ValidationResult success()
      Create a success result.
      Returns:
      a valid ValidationResult

    • failure

      public static ValidationResult failure(String message)
      Create a failure result.
      Parameters:
      message - the error message
      Returns:
      an invalid ValidationResult

    • 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 the compare method from their corresponding wrapper classes.
      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

    • errorMessage

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