Package io.jenkins.plugins.explain_error

Class ExplanationLabels

java.lang.Object
io.jenkins.plugins.explain_error.ExplanationLabels
public final class ExplanationLabels extends Object
The fixed words around an explanation ("Summary", "How to fix it", ...), in the language the explanation itself is written in.

The language setting is free text ("中文", "Chinese", "zh-CN", "Español"), so it is matched against the names and tags of the languages there are labels for. Anything else gets English, which is also what the labels were before they could be translated.

  • Method Details

    • forLanguage

      @NonNull public static ExplanationLabels forLanguage(@CheckForNull String language)
      Labels for a language setting; English for null, blank or a language without labels.

    • getSummary

      public String getSummary()
      Label of the summary in the plain-text explanation.

    • getFailedSnippet

      public String getFailedSnippet()
      Label of the log excerpt in the plain-text explanation.

    • getResolutionSteps

      public String getResolutionSteps()
      Label of the steps in the plain-text explanation.

    • getBestPractices

      public String getBestPractices()
      Label of the best practices in the plain-text explanation.

    • getBestPracticesHeading

      public String getBestPracticesHeading()
      Heading of the best practices in the panel.

    • getHowToFix

      public String getHowToFix()
      Heading of the steps in the panel.

    • getWhereItFailed

      public String getWhereItFailed()
      Heading of the log excerpt in the panel.

    • linesAnalysed

      public String linesAnalysed(int count)
      "n log lines analysed", for the line under the explanation.

    • reusedFrom

      public String reusedFrom(int buildNumber)
      Says which earlier build an explanation was taken over from.

    • generatedOn

      public String generatedOn(String time)
      "Generated on ...", for the line under the explanation where the time is not shown elsewhere.