com.github.cukedoctor.jenkins

Class CukedoctorPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.github.cukedoctor.jenkins.CukedoctorPublisher

All Implemented Interfaces:

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

public class CukedoctorPublisher
extends hudson.tasks.Recorder
implements jenkins.tasks.SimpleBuildStep

Author:

rmpestano

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CukedoctorPublisher.DescriptorImpl

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

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 inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
CukedoctorPublisher(String featuresDir, FormatType format, TocType toc, Boolean numbered, Boolean sectAnchors, String title, boolean hideFeaturesSection, boolean hideSummary, boolean hideScenarioKeyword, boolean hideStepTime, boolean hideTags)

Method Summary

Modifier and Type	Method and Description
protected void	generateDocumentation(List<com.github.cukedoctor.api.model.Feature> features, com.github.cukedoctor.api.DocumentAttributes attrs, com.github.cukedoctor.config.CukedoctorConfig cukedoctorConfig, String outputPath, org.asciidoctor.Asciidoctor asciidoctor)
String	getFeaturesDir()
FormatType	getFormat()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getTitle()
TocType	getToc()
boolean	isHideFeaturesSection()
boolean	isHideScenarioKeyword()
boolean	isHideStepTime()
boolean	isHideSummary()
boolean	isHideTags()
boolean	isNumbered()
boolean	isSectAnchors()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setFeaturesDir(String featuresDir)
void	setFormat(FormatType format)
void	setHideFeaturesSection(boolean hideFeaturesSection)
void	setHideScenarioKeyword(boolean hideScenarioKeyword)
void	setHideStepTime(boolean hideStepTime)
void	setHideSummary(boolean hideSummary)
void	setHideTags(boolean hideTags)
void	setNumbered(boolean numbered)
void	setSectAnchors(boolean sectAnchors)
void	setTitle(String title)
void	setToc(TocType toc)

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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, perform, prebuild

Constructor Detail

CukedoctorPublisher

@DataBoundConstructor
public CukedoctorPublisher(String featuresDir,
                                                 FormatType format,
                                                 TocType toc,
                                                 Boolean numbered,
                                                 Boolean sectAnchors,
                                                 String title,
                                                 boolean hideFeaturesSection,
                                                 boolean hideSummary,
                                                 boolean hideScenarioKeyword,
                                                 boolean hideStepTime,
                                                 boolean hideTags)

Method Detail

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

IOException

InterruptedException

generateDocumentation

protected void generateDocumentation(List<com.github.cukedoctor.api.model.Feature> features,
                                     com.github.cukedoctor.api.DocumentAttributes attrs,
                                     com.github.cukedoctor.config.CukedoctorConfig cukedoctorConfig,
                                     String outputPath,
                                     org.asciidoctor.Asciidoctor asciidoctor)

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getFeaturesDir

public String getFeaturesDir()

isNumbered

public boolean isNumbered()

isSectAnchors

public boolean isSectAnchors()

getToc

public TocType getToc()

getFormat

public FormatType getFormat()

getTitle

public String getTitle()

isHideFeaturesSection

public boolean isHideFeaturesSection()

isHideSummary

public boolean isHideSummary()

isHideScenarioKeyword

public boolean isHideScenarioKeyword()

isHideStepTime

public boolean isHideStepTime()

isHideTags

public boolean isHideTags()

setFeaturesDir

@DataBoundSetter
public void setFeaturesDir(String featuresDir)

setNumbered

@DataBoundSetter
public void setNumbered(boolean numbered)

setSectAnchors

@DataBoundSetter
public void setSectAnchors(boolean sectAnchors)

setToc

@DataBoundSetter
public void setToc(TocType toc)

setFormat

@DataBoundSetter
public void setFormat(FormatType format)

setTitle

@DataBoundSetter
public void setTitle(String title)

setHideFeaturesSection

@DataBoundSetter
public void setHideFeaturesSection(boolean hideFeaturesSection)

setHideSummary

@DataBoundSetter
public void setHideSummary(boolean hideSummary)

setHideScenarioKeyword

@DataBoundSetter
public void setHideScenarioKeyword(boolean hideScenarioKeyword)

setHideStepTime

@DataBoundSetter
public void setHideStepTime(boolean hideStepTime)

setHideTags

@DataBoundSetter
public void setHideTags(boolean hideTags)