Record Class ConstraintViolation

java.lang.Object
java.lang.Record
io.avaje.validation.ConstraintViolation
public record ConstraintViolation(String path, String field, String message) extends Record
Describes a constraint violation. This object exposes the constraint violation context as well as the message describing the violation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConstraintViolation(String path, String field, String message)
    Creates an instance of a ConstraintViolation 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
    field()
    Returns the value of the field record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    message()
    Returns the value of the message record component.
    String
    path()
    Returns the value of the path record component.
    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

  • Constructor Details

    • ConstraintViolation

      public ConstraintViolation(String path, String field, String message)
      Creates an instance of a ConstraintViolation record class.
      Parameters:
      path - the value for the path record component
      field - the value for the field record component
      message - the value for the message record component

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

    • path

      public String path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component

    • field

      public String field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component

    • message

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