Package io.jenkins.plugins.forensics.reference

Class ReferenceBuild

java.lang.Object
io.jenkins.plugins.forensics.reference.ReferenceBuild
All Implemented Interfaces:
Action, ModelObject, Serializable, RunAction2, org.kohsuke.stapler.StaplerProxy
public class ReferenceBuild extends Object implements RunAction2, Serializable, org.kohsuke.stapler.StaplerProxy
Stores the selected reference build for a given build. The reference build is a build in a different (or same) Jenkins job that can be used to compute delta reports.
Author:
Ullrich Hafner
See Also:

  • Field Details

    • NO_REFERENCE_BUILD

      public static final String NO_REFERENCE_BUILD
      Indicates that no reference build has been found. Note that this value is not used when the build has been found initially but has been deleted afterward.
      See Also:

  • Constructor Details

    • ReferenceBuild

      public ReferenceBuild(Run<?,?> owner, List<String> messages, Result requiredResult)
      Creates a new instance of ReferenceBuild that indicates that no reference build has been found.
      Parameters:
      owner - the current run as the owner of this action
      messages - messages that show the steps the resolution process
      requiredResult - the required build result of the chosen reference build

    • ReferenceBuild

      public ReferenceBuild(Run<?,?> owner, List<String> messages, Result requiredResult, Run<?,?> referenceBuild)
      Creates a new instance of ReferenceBuild that points to the specified reference build.
      Parameters:
      owner - the current build as the owner of this action
      messages - messages that show the steps of the resolution process
      requiredResult - the required build result of the chosen reference build
      referenceBuild - the found reference build

    • ReferenceBuild

      @Deprecated public ReferenceBuild(Run<?,?> owner, List<String> messages)
      Deprecated.
      use ReferenceBuild(Run, List, Result) instead
      Creates a new instance of ReferenceBuild that indicates that no reference build has been found.
      Parameters:
      owner - the current run as the owner of this action
      messages - messages that show the steps the resolution process

    • ReferenceBuild

      @Deprecated public ReferenceBuild(Run<?,?> owner, List<String> messages, Run<?,?> referenceBuild)
      Deprecated.
      use ReferenceBuild(Run, List, Result, Run) instead
      Creates a new instance of ReferenceBuild that points to the specified reference build.
      Parameters:
      owner - the current build as the owner of this action
      messages - messages that show the steps of the resolution process
      referenceBuild - the found reference build

  • Method Details

    • getReferenceBuildLink

      public static String getReferenceBuildLink(String referenceBuildId)
      Returns a link that can be used in Jelly views to navigate to the reference build.
      Parameters:
      referenceBuildId - ID of the reference build
      Returns:
      the link

    • readResolve

      protected Object readResolve()
      Called after deserialization to retain backward compatibility.
      Returns:
      this

    • onAttached

      public void onAttached(Run<?,?> run)
      Specified by:
      onAttached in interface RunAction2

    • onLoad

      public void onLoad(Run<?,?> run)
      Specified by:
      onLoad in interface RunAction2

    • getOwner

      public Run<?,?> getOwner()

    • getMessages

      public List<String> getMessages()

    • getReferenceLink

      public String getReferenceLink()
      Returns a link that can be used in Jelly views to navigate to the reference build.
      Returns:
      the link

    • hasReferenceBuild

      public boolean hasReferenceBuild()
      Determines if a reference build has been recorded or not.
      Returns:
      true if a reference build has been recorded, false if not

    • getReferenceBuildId

      public String getReferenceBuildId()
      Returns the ID of the reference build. If no reference build is available, then the constant string NO_REFERENCE_BUILD will be returned.
      Returns:
      the ID of the reference build

    • getReferenceBuild

      public Optional<Run<?,?>> getReferenceBuild()
      Returns the actual reference build. Note that a reference build might be not available anymore, because it has been deleted in the meantime.
      Returns:
      the reference build, if still available

    • getRequiredResult

      public Result getRequiredResult()
      Returns the required build result of the chosen reference build.
      Returns:
      the required build result

    • getDisplayName

      public String getDisplayName()
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject

    • getIconFileName

      public String getIconFileName()
      Specified by:
      getIconFileName in interface Action

    • getUrlName

      public String getUrlName()
      Specified by:
      getUrlName in interface Action

    • getTarget

      public Object getTarget()
      Returns the detail view for the messages captured during the computation of the reference build.
      Specified by:
      getTarget in interface org.kohsuke.stapler.StaplerProxy
      Returns:
      the detail view for the messages