Package io.jenkins.plugins.analysis.core.model

Class AnalysisHistory

java.lang.Object
io.jenkins.plugins.analysis.core.model.AnalysisHistory
All Implemented Interfaces:
History, Iterable<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>>
public class AnalysisHistory extends Object implements History
Provides a history of static analysis results. The history starts from a baseline build and provides access to a historical build result of the same type (or to all historical results using the provided interator implementation). The results are filtered by a ResultSelector, so a history returns only results of the same type. This history can be configured to ignore the builds that did not pass the quality gate (see QualityGateEvaluationMode). Note that the baseline run might still be in progress and thus has not yet a result attached: i.e., the result of the getPrevious* methods may return different results on subsequent calls.
Author:
Ullrich Hafner

  • Constructor Details

    • AnalysisHistory

      public AnalysisHistory(Run<?,?> baseline, ResultSelector selector)
      Creates a new instance of AnalysisHistory.
      Parameters:
      baseline - the build to start the history from
      selector - selects the associated action from a build

  • Method Details

    • getBaselineAction

      public Optional<ResultAction> getBaselineAction()
      Description copied from interface: History
      Returns the baseline action (if already available).
      Specified by:
      getBaselineAction in interface History
      Returns:
      the baseline action

    • getBaselineResult

      public Optional<AnalysisResult> getBaselineResult()
      Description copied from interface: History
      Returns the baseline result (if already available).
      Specified by:
      getBaselineResult in interface History
      Returns:
      the baseline result

    • getResult

      public Optional<AnalysisResult> getResult()
      Description copied from interface: History
      Returns the historical result (if there is any).
      Specified by:
      getResult in interface History
      Returns:
      the historical result

    • getBuild

      public Optional<Run<?,?>> getBuild()
      Description copied from interface: History
      Returns the build that contains the historical result (if there is any).
      Specified by:
      getBuild in interface History
      Returns:
      the historical result

    • getIssues

      public edu.hm.hafner.analysis.Report getIssues()
      Description copied from interface: History
      Returns the issues of the historical result. If there is no historical build found, then an empty set of issues is returned.
      Specified by:
      getIssues in interface History
      Returns:
      the issues of the historical build

    • hasMultipleResults

      public boolean hasMultipleResults()
      Description copied from interface: History
      Returns whether this history has more than one result.
      Specified by:
      hasMultipleResults in interface History
      Returns:
      true if there are multiple results, false otherwise

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • iterator

      @NonNull public Iterator<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>> iterator()
      Specified by:
      iterator in interface History
      Specified by:
      iterator in interface Iterable<edu.hm.hafner.echarts.BuildResult<AnalysisBuildResult>>