Package org.variantsync.diffdetective.diff.result

Record Class CommitDiffResult

java.lang.Object
java.lang.Record
org.variantsync.diffdetective.diff.result.CommitDiffResult
Record Components:
diff - A CommitDiff upon a (partially) successful computation or nothing otherwise.
errors - A list of errors that occured while processing the commit's diffs.
public record CommitDiffResult(Optional<CommitDiff> diff, List<DiffError> errors) extends Record
The result of processing all diffs of a commit.

  • Field Details

  • Constructor Details

    • CommitDiffResult

      public CommitDiffResult(Optional<CommitDiff> diff, List<DiffError> errors)
      Creates an instance of a CommitDiffResult record class.
      Parameters:
      diff - the value for the diff record component
      errors - the value for the errors record component

  • Method Details

    • Failure

      public static CommitDiffResult Failure(DiffError error, String message)
      Creates a result that indicates failure from a single error. The result will hold no diff and a list containing the single error.
      Parameters:
      error - The error that occurred.
      message - An additional error message that should be logged.
      Returns:
      A failure result that was caused by the given error.

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

    • diff

      public Optional<CommitDiff> diff()
      Returns the value of the diff record component.
      Returns:
      the value of the diff record component

    • errors

      public List<DiffError> errors()
      Returns the value of the errors record component.
      Returns:
      the value of the errors record component