Package io.jenkins.plugins.explain_error

Record Class JenkinsLogAnalysis

java.lang.Object
java.lang.Record
io.jenkins.plugins.explain_error.JenkinsLogAnalysis
public record JenkinsLogAnalysis(String errorSummary, List<String> resolutionSteps, List<String> bestPractices, String errorSignature, String title) extends Record

  • Constructor Details

    • JenkinsLogAnalysis

      public JenkinsLogAnalysis(String errorSummary, List<String> resolutionSteps, List<String> bestPractices, String errorSignature)
      For callers and stored data from before the title existed.

    • JenkinsLogAnalysis

      public JenkinsLogAnalysis(String errorSummary, List<String> resolutionSteps, List<String> bestPractices, String errorSignature, String title)
      Creates an instance of a JenkinsLogAnalysis record class.
      Parameters:
      errorSummary - the value for the errorSummary record component
      resolutionSteps - the value for the resolutionSteps record component
      bestPractices - the value for the bestPractices record component
      errorSignature - the value for the errorSignature record component
      title - the value for the title record component

  • Method Details

    • toString

      public 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

    • toText

      public String toText(ExplanationLabels labels)
      The analysis as plain text, with its section labels in the language of labels.

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

    • errorSummary

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

    • resolutionSteps

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

    • bestPractices

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

    • errorSignature

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

    • title

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