Package org.approvej.review

Record Class AutomaticFileReviewer

java.lang.Object
java.lang.Record
org.approvej.review.AutomaticFileReviewer
All Implemented Interfaces:
Function<PathProvider,ReviewResult>, Provider<FileReviewer>, FileReviewer, FileReviewerProvider
@NullMarked public record AutomaticFileReviewer() extends Record implements FileReviewer, FileReviewerProvider
A FileReviewer that accepts any given received value, ignoring the previously approved value.

This may be a good idea when you have a lot of tests with changed results, and you simply want to update them all at once. You probably want to review the changed approved files before committing them to version control!

  • Constructor Details

    • AutomaticFileReviewer

      public AutomaticFileReviewer()
      Creates an instance of a AutomaticFileReviewer record class.

  • Method Details

    • apply

      public ReviewResult apply(PathProvider pathProvider)
      Specified by:
      apply in interface Function<PathProvider,ReviewResult>

    • alias

      public String alias()
      Description copied from interface: Provider
      Returns the alias that can be used to reference this provider in configuration.

      For example, "json" or "yaml" for print formats, or "none" or "automatic" for reviewers.

      Specified by:
      alias in interface Provider<FileReviewer>
      Returns:
      the alias for this provider

    • create

      public FileReviewer create()
      Description copied from interface: Provider
      Creates a new instance of the component.

      When implemented by the component class itself, this typically returns a new instance of the same class via its no-argument constructor.

      Specified by:
      create in interface Provider<FileReviewer>
      Returns:
      a new instance of the component

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