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)

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, String outputPath, org.asciidoctor.Asciidoctor asciidoctor)
String	getFeaturesDir()
FormatType	getFormat()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getTitle()
TocType	getToc()
boolean	isNumbered()
boolean	isSectAnchors()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)

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

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

getProjectActions, perform, prebuild

Constructor Detail

CukedoctorPublisher

@DataBoundConstructor
public CukedoctorPublisher(String featuresDir,
                                                 FormatType format,
                                                 TocType toc,
                                                 boolean numbered,
                                                 boolean sectAnchors,
                                                 String title)

Method Detail

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

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,
                                     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()