Package io.jenkins.plugins.coverage.metrics.steps

Class CoverageTokenMacro

java.lang.Object
org.jenkinsci.plugins.tokenmacro.TokenMacro
org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro
io.jenkins.plugins.coverage.metrics.steps.CoverageTokenMacro
All Implemented Interfaces:
ExtensionPoint
@OptionalExtension(requireClasses=org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro.class) public class CoverageTokenMacro extends org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro
Provides a token that evaluates the number of issues.
Author:
Ullrich Hafner

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro.Parameter

    Nested classes/interfaces inherited from interface hudson.ExtensionPoint

    ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Field Summary

    Fields inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    escapeHtml

  • Constructor Summary

    Constructors
    Constructor
    Description
    CoverageTokenMacro()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    acceptsMacroName(String macroName)
     
    String
    evaluate(AbstractBuild<?,?> abstractBuild, TaskListener taskListener, String macroName)
     
    String
    evaluate(Run<?,?> run, FilePath workspace, TaskListener listener, String macroName)
     
    void
    setBaseline(String baseline)
    Defines which baseline should be used when evaluating the macro.
    void
    setId(String id)
    Determines which ID should be used to choose the action for the macro evaluation.
    void
    setMetric(String metric)
    Defines which metric should be used when evaluating the macro.

    Methods inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    evaluate, evaluate, handlesHtmlEscapeInternally, hasNestedContent

    Methods inherited from class org.jenkinsci.plugins.tokenmacro.TokenMacro

    all, expand, expand, expand, expand, expandAll, expandAll, expandAll, expandAll, getAcceptedMacroNames, getAutoCompleteList, getPreviousRun, getWorkspace

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CoverageTokenMacro

      public CoverageTokenMacro()

  • Method Details

    • setId

      public void setId(String id)
      Determines which ID should be used to choose the action for the macro evaluation.
      Parameters:
      id - the ID of the results to select

    • setMetric

      public void setMetric(String metric)
      Defines which metric should be used when evaluating the macro.
      Parameters:
      metric - the metric of the values to show

    • setBaseline

      public void setBaseline(String baseline)
      Defines which baseline should be used when evaluating the macro.
      Parameters:
      baseline - the baseline of the values to show

    • acceptsMacroName

      public boolean acceptsMacroName(String macroName)
      Specified by:
      acceptsMacroName in class org.jenkinsci.plugins.tokenmacro.TokenMacro

    • evaluate

      public String evaluate(AbstractBuild<?,?> abstractBuild, TaskListener taskListener, String macroName)
      Specified by:
      evaluate in class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    • evaluate

      public String evaluate(Run<?,?> run, FilePath workspace, TaskListener listener, String macroName)
      Overrides:
      evaluate in class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro