Class SonargraphReportBuilder

  • All Implemented Interfaces:
    IReportPathProvider, hudson.ExtensionPoint, hudson.model.Action, hudson.model.Describable<hudson.tasks.Publisher>, hudson.model.ModelObject, hudson.tasks.BuildStep, Serializable, jenkins.model.RunAction2, jenkins.tasks.SimpleBuildStep, jenkins.tasks.SimpleBuildStep.LastBuildAction

    @Symbol("SonargraphReport")
    public final class SonargraphReportBuilder
    extends AbstractSonargraphRecorder
    implements IReportPathProvider, jenkins.tasks.SimpleBuildStep, jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.model.RunAction2, Serializable
    This class contains all the functionality of the build step.
    See Also:
    Serialized Form
    • Constructor Detail

      • SonargraphReportBuilder

        @DataBoundConstructor
        public SonargraphReportBuilder()
    • Method Detail

      • setSkip

        @DataBoundSetter
        public void setSkip​(boolean skip)
      • setUseHttpProxy

        @DataBoundSetter
        public void setUseHttpProxy​(boolean useHttpProxy)
      • setSystemDirectory

        @DataBoundSetter
        public void setSystemDirectory​(String systemDirectory)
      • setQualityModelFile

        @DataBoundSetter
        public void setQualityModelFile​(String qualityModelFile)
      • setVirtualModel

        @DataBoundSetter
        public void setVirtualModel​(String virtualModel)
      • setReportPath

        @DataBoundSetter
        public void setReportPath​(String reportPath)
      • setBaselineReportPath

        @DataBoundSetter
        public void setBaselineReportPath​(String baselineReportPath)
      • setReportGeneration

        @DataBoundSetter
        public void setReportGeneration​(String reportGeneration)
      • setChartConfiguration

        @DataBoundSetter
        public void setChartConfiguration​(String chartConfiguration)
      • setMetrics

        @DataBoundSetter
        public void setMetrics​(List<Metric> metrics)
      • setMetaDataFile

        @DataBoundSetter
        public void setMetaDataFile​(String metaDataFile)
      • setLanguageJava

        @DataBoundSetter
        public void setLanguageJava​(boolean languageJava)
      • setLanguageCSharp

        @DataBoundSetter
        public void setLanguageCSharp​(boolean languageCSharp)
      • setLanguageCPlusPlus

        @DataBoundSetter
        public void setLanguageCPlusPlus​(boolean languageCPlusPlus)
      • setLanguagePython

        @DataBoundSetter
        public void setLanguagePython​(boolean languagePython)
      • setSonargraphBuildJDK

        @DataBoundSetter
        public void setSonargraphBuildJDK​(String sonargraphBuildJDK)
      • setSonargraphBuildVersion

        @DataBoundSetter
        public void setSonargraphBuildVersion​(String sonargraphBuildVersion)
      • setActivationCode

        @DataBoundSetter
        public void setActivationCode​(String activationCode)
      • setLicenseFile

        @DataBoundSetter
        public void setLicenseFile​(String licenseFile)
      • setWorkspaceProfile

        @DataBoundSetter
        public void setWorkspaceProfile​(String workspaceProfile)
      • setSnapshotDirectory

        @DataBoundSetter
        public void setSnapshotDirectory​(String snapshotDirectory)
      • setSnapshotFileName

        @DataBoundSetter
        public void setSnapshotFileName​(String snapshotFileName)
      • setLogLevel

        @DataBoundSetter
        public void setLogLevel​(String logLevel)
      • setLogFile

        @DataBoundSetter
        public void setLogFile​(String logFile)
      • getProjectActions

        public Collection<hudson.model.Action> getProjectActions​(hudson.model.AbstractProject<?,​?> project)
        We override the getProjectAction method to define our custom action that will show the charts for sonargraph's metrics.
        Specified by:
        getProjectActions in interface hudson.tasks.BuildStep
        Overrides:
        getProjectActions in class hudson.tasks.BuildStepCompatibilityLayer
      • getBaselineReportPath

        public String getBaselineReportPath()
      • diffReportCreated

        public boolean diffReportCreated()
      • getMetaDataFile

        public String getMetaDataFile()
      • getLanguageJava

        public boolean getLanguageJava()
      • getLanguageCSharp

        public boolean getLanguageCSharp()
      • getLanguageCPlusPlus

        public boolean getLanguageCPlusPlus()
      • getLanguagePython

        public boolean getLanguagePython()
      • getLanguages

        protected static String getLanguages​(boolean languageJava,
                                             boolean languageCPlusPlus,
                                             boolean languageCSharp,
                                             boolean languagePython)
        Returns comma separated list of languages in 'Sonargraph historical' order.
        Returns:
      • getSonargraphBuildJDK

        public String getSonargraphBuildJDK()
      • getSonargraphBuildVersion

        public String getSonargraphBuildVersion()
      • getActivationCode

        public String getActivationCode()
      • getLicenseFile

        public String getLicenseFile()
      • getWorkspaceProfile

        public String getWorkspaceProfile()
      • getSnapshotDirectory

        public String getSnapshotDirectory()
      • getSnapshotFileName

        public String getSnapshotFileName()
      • getLogLevel

        public String getLogLevel()
        Returns:
        the logLevel
      • getLogFile

        public String getLogFile()
      • getSystemDirectory

        public String getSystemDirectory()
      • getReportGeneration

        public String getReportGeneration()
      • getChartConfiguration

        public String getChartConfiguration()
      • getQualityModelFile

        public String getQualityModelFile()
      • getVirtualModel

        public String getVirtualModel()
      • isGeneratedBySonargraphBuild

        public boolean isGeneratedBySonargraphBuild()
      • isPreGenerated

        public boolean isPreGenerated()
      • isAllCharts

        public boolean isAllCharts()
      • isJavaCharts

        public boolean isJavaCharts()
      • isCplusplusCharts

        public boolean isCplusplusCharts()
      • isCsharpCharts

        public boolean isCsharpCharts()
      • isPythonCharts

        public boolean isPythonCharts()
      • isSelectedCharts

        public boolean isSelectedCharts()
      • isSkip

        public boolean isSkip()
      • isUseHttpProxy

        public boolean isUseHttpProxy()
      • getDescriptor

        public SonargraphReportBuilder.DescriptorImpl getDescriptor()
        Specified by:
        getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>
        Overrides:
        getDescriptor in class hudson.tasks.Recorder
      • validateNotNullAndRegexp

        public static boolean validateNotNullAndRegexp​(String value,
                                                       String pattern)
      • getIconFileName

        public String getIconFileName()
        Specified by:
        getIconFileName in interface hudson.model.Action
      • getDisplayName

        public String getDisplayName()
        Specified by:
        getDisplayName in interface hudson.model.Action
        Specified by:
        getDisplayName in interface hudson.model.ModelObject
      • getUrlName

        public String getUrlName()
        Specified by:
        getUrlName in interface hudson.model.Action
      • getProjectActions

        public Collection<? extends hudson.model.Action> getProjectActions()
        Specified by:
        getProjectActions in interface jenkins.tasks.SimpleBuildStep.LastBuildAction
      • onAttached

        public void onAttached​(hudson.model.Run<?,​?> run)
        Specified by:
        onAttached in interface jenkins.model.RunAction2
      • onLoad

        public void onLoad​(hudson.model.Run<?,​?> run)
        Specified by:
        onLoad in interface jenkins.model.RunAction2