Package org.approvej.review

Record Class FileReviewerScript

java.lang.Object
java.lang.Record
org.approvej.review.FileReviewerScript
Record Components:
script - the script to be executed with placeholders "{receivedFile}" and "{approvedFile}"
All Implemented Interfaces:
Function<PathProvider,ReviewResult>, FileReviewer
public record FileReviewerScript(String script) extends Record implements FileReviewer
A FileReviewer implementation that executes the given script.

  • Constructor Details

    • FileReviewerScript

      public FileReviewerScript(String script)
      Creates an instance of a FileReviewerScript record class.
      Parameters:
      script - the value for the script record component

  • Method Details

    • script

      public static FileReviewerScript script(String script)
      A FileReviewer implementation that executes the given script.
      Parameters:
      script - the script to be executed with placeholders "{receivedFile}" and "{approvedFile}"
      Returns:
      the new FileReviewerScript

    • apply

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

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

    • script

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