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 of data series.
List<PropertiesSeries>	propertiesSeries
List<XMLSeries>	xmlSeries

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
PlotBuilder(String group, String style, String csvFileName)

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()
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)
void	setCsvSeries(List<CSVSeries> csvSeries)
void	setDescription(String description)
void	setExclZero(boolean exclZero)
void	setKeepRecords(boolean keepRecords)
void	setLogarithmic(boolean logarithmic)
void	setNumBuilds(String numBuilds)
void	setPropertiesSeries(List<PropertiesSeries> propertiesSeries)
void	setTitle(String title)
void	setUseDescr(boolean useDescr)
void	setXmlSeries(List<XMLSeries> xmlSeries)
void	setYaxis(String yaxis)
void	setYaxisMaximum(String yaxisMaximum)
void	setYaxisMinimum(String yaxisMinimum)

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

csvSeries

public List<CSVSeries> csvSeries

List of data series.

propertiesSeries

public List<PropertiesSeries> propertiesSeries

xmlSeries

public List<XMLSeries> xmlSeries

Constructor Detail

PlotBuilder

@DataBoundConstructor
public PlotBuilder(String group,
                                         String style,
                                         String csvFileName)

Method Detail

getGroup

public String getGroup()

getStyle

public String getStyle()

getTitle

@CheckForNull
public String getTitle()

setTitle

@DataBoundSetter
public final void setTitle(@CheckForNull
                                            String title)

getNumBuilds

@CheckForNull
public String getNumBuilds()

setNumBuilds

@DataBoundSetter
public final void setNumBuilds(@CheckForNull
                                                String numBuilds)

getYaxis

@CheckForNull
public String getYaxis()

setYaxis

@DataBoundSetter
public final void setYaxis(@CheckForNull
                                            String yaxis)

getUseDescr

public boolean getUseDescr()

setUseDescr

@DataBoundSetter
public void setUseDescr(boolean useDescr)

getExclZero

public boolean getExclZero()

setExclZero

@DataBoundSetter
public void setExclZero(boolean exclZero)

getLogarithmic

public boolean getLogarithmic()

setLogarithmic

@DataBoundSetter
public void setLogarithmic(boolean logarithmic)

getKeepRecords

public boolean getKeepRecords()

setKeepRecords

@DataBoundSetter
public void setKeepRecords(boolean keepRecords)

getYaxisMinimum

@CheckForNull
public String getYaxisMinimum()

setYaxisMinimum

@DataBoundSetter
public final void setYaxisMinimum(@CheckForNull
                                                   String yaxisMinimum)

getYaxisMaximum

@CheckForNull
public String getYaxisMaximum()

setYaxisMaximum

@DataBoundSetter
public final void setYaxisMaximum(@CheckForNull
                                                   String yaxisMaximum)

setDescription

@DataBoundSetter
public final void setDescription(@CheckForNull
                                                  String description)

getCsvSeries

public List<CSVSeries> getCsvSeries()

setCsvSeries

@DataBoundSetter
public void setCsvSeries(List<CSVSeries> csvSeries)

getPropertiesSeries

public List<PropertiesSeries> getPropertiesSeries()

setPropertiesSeries

@DataBoundSetter
public void setPropertiesSeries(List<PropertiesSeries> propertiesSeries)

getXmlSeries

public List<XMLSeries> getXmlSeries()

setXmlSeries

@DataBoundSetter
public void setXmlSeries(List<XMLSeries> xmlSeries)

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