Record Class Constraint<T>

java.lang.Object
java.lang.Record
be.sddevelopment.validation.core.Constraint<T>
Type Parameters:
T - type of the object onto which the rule can be applied
Record Components:
rule - a method that accepts an object of type T and returns a boolean that indicates if it matches the validation criterium.
description - textual description of the validation rule
public record Constraint<T>(Predicate<T> rule, String description) extends Record
Represents a single constraint / validation rule, which can be applied to an object of type T.
Version:
1.0.0-SNAPSHOT
Author:
Stijn Dejongh

  • Constructor Details

    • Constraint

      public Constraint(Predicate<T> rule, String description)
      Creates an instance of a Constraint record class.
      Parameters:
      rule - the value for the rule record component
      description - the value for the description record component

  • Method Details

    • ruleFor

      public static <S> Constraint.ConstraintBuilder<S> ruleFor(Class<S> ignoredClass)
      Factory method to create a new Constraint.ConstraintBuilder instance.
      Type Parameters:
      S - type of the object onto which the rule can be applied
      Parameters:
      ignoredClass - class to be ignored, as this method is only used as a type parameter to create a new instance of the builder
      Returns:
      a new instance of the Constraint.ConstraintBuilder class, able to evaluate a rule on an object of type S

    • applyTo

      public Reason applyTo(T toTest)

    • equals

      @Generated("generated by IDE, using Apache Commons Lang3") public 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.

    • hashCode

      @Generated("generated by IDE, using Apache Commons Lang3") public 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

    • 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

    • rule

      public Predicate<T> rule()
      Returns the value of the rule record component.
      Returns:
      the value of the rule record component

    • description

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