Package org.apache.juneau.terminal.report

Record Class ReportResult

java.lang.Object
java.lang.Record
org.apache.juneau.terminal.report.ReportResult
Record Components:
fw - The framework key.
tests - The recovered tests, in report order.
warnings - Human-readable warnings, for example report truncated: unexpected end of file after 4120 tests.
truncated - Whether the file ended early or the test limit was hit.
skippedFiles - The number of files that were not read (over the size limit, unreadable).
public record ReportResult(String fw, List<ReportTest> tests, List<String> warnings, boolean truncated, int skippedFiles) extends Record
What a ReportReader recovered from a report.

  • Constructor Details

    • ReportResult

      public ReportResult(String fw, List<ReportTest> tests, List<String> warnings, boolean truncated, int skippedFiles)
      Constructor.
      Parameters:
      fw - The framework key.
      tests - The recovered tests.
      warnings - Human-readable warnings.
      truncated - Whether the file ended early or the test limit was hit.
      skippedFiles - The number of files that were not read.

  • Method Details

    • toEvents

      public List<TerminalEvent> toEvents(String step)
      Returns the events a producer appends at the end of a step.

      The sequence is a replace for the step, one test per recovered test, then one warn note per warning. When no test was recovered and there are warnings, only the notes are returned, so the step keeps its live suite placeholders. A valid but empty report yields just the replace.

      Parameters:
      step - The id of the step the results belong to.
      Returns:
      The events, not yet numbered.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • fw

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

    • tests

      public List<ReportTest> tests()
      Returns the value of the tests record component.
      Returns:
      the value of the tests record component

    • warnings

      public List<String> warnings()
      Returns the value of the warnings record component.
      Returns:
      the value of the warnings record component

    • truncated

      public boolean truncated()
      Returns the value of the truncated record component.
      Returns:
      the value of the truncated record component

    • skippedFiles

      public int skippedFiles()
      Returns the value of the skippedFiles record component.
      Returns:
      the value of the skippedFiles record component