hudson.plugins.plot

Class PlotBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.plugins.plot.PlotBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class PlotBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Plot Builder class for pipeline.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new PlotBuilder is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields (like group) to remember the configuration.

When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) method will be invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlotBuilder.DescriptorImpl Descriptor for PlotBuilder.

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	csvFileName
List<CSVSeries>	csvSeries
List<PropertiesSeries>	propertiesSeries
List<Series>	series List of data series.
List<XMLSeries>	xmlSeries

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
PlotBuilder(String group, String title, String numBuilds, String yaxis, String style, Boolean useDescr, Boolean exclZero, Boolean logarithmic, Boolean keepRecords, String yaxisMinimum, String yaxisMaximum, String csvFileName, List<CSVSeries> csvSeries, List<PropertiesSeries> propertiesSeries, List<XMLSeries> xmlSeries)

Method Summary

Modifier and Type	Method and Description
List<CSVSeries>	getCsvSeries()
PlotBuilder.DescriptorImpl	getDescriptor()
Boolean	getExclZero()
String	getGroup()
Boolean	getKeepRecords()
Boolean	getLogarithmic()
String	getNumBuilds()
List<PropertiesSeries>	getPropertiesSeries()
List<Series>	getSeries()
String	getStyle()
String	getTitle()
Boolean	getUseDescr()
List<XMLSeries>	getXmlSeries()
String	getYaxis()
String	getYaxisMaximum()
String	getYaxisMinimum()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Field Detail

csvFileName

public String csvFileName

series

public List<Series> series

List of data series.

csvSeries

public List<CSVSeries> csvSeries

propertiesSeries

public List<PropertiesSeries> propertiesSeries

xmlSeries

public List<XMLSeries> xmlSeries

Constructor Detail

PlotBuilder

@DataBoundConstructor
public PlotBuilder(String group,
                                         String title,
                                         String numBuilds,
                                         String yaxis,
                                         String style,
                                         Boolean useDescr,
                                         Boolean exclZero,
                                         Boolean logarithmic,
                                         Boolean keepRecords,
                                         String yaxisMinimum,
                                         String yaxisMaximum,
                                         String csvFileName,
                                         List<CSVSeries> csvSeries,
                                         List<PropertiesSeries> propertiesSeries,
                                         List<XMLSeries> xmlSeries)

Method Detail

getGroup

public String getGroup()

getTitle

public String getTitle()

getNumBuilds

public String getNumBuilds()

getYaxis

public String getYaxis()

getStyle

public String getStyle()

getUseDescr

public Boolean getUseDescr()

getExclZero

public Boolean getExclZero()

getLogarithmic

public Boolean getLogarithmic()

getKeepRecords

public Boolean getKeepRecords()

getYaxisMinimum

public String getYaxisMinimum()

getYaxisMaximum

public String getYaxisMaximum()

getSeries

public List<Series> getSeries()

getCsvSeries

public List<CSVSeries> getCsvSeries()

getPropertiesSeries

public List<PropertiesSeries> getPropertiesSeries()

getXmlSeries

public List<XMLSeries> getXmlSeries()

perform

public void perform(hudson.model.Run<?,?> build,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

getDescriptor

public PlotBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder