io.jenkins.plugins.VisualExpert

Class VisualExpertBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.VisualExpert.VisualExpertBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class VisualExpertBuilder
extends Builder
implements SimpleBuildStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisualExpertBuilder.Descriptor
static class	VisualExpertBuilder.VEProjectsLister

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSOLE_EXE_NAME

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
VisualExpertBuilder(String projectName, String reportPath, String reportFormat, Boolean generateReport, Boolean doAnalysis, Boolean createReferenceDocument, Boolean createCodeReviewDocument) //@param installPath: Visual Expert application (Executable) containing directory path

Method Summary

Modifier and Type	Method and Description
static String	getConsoleExePath(String installationfolder)
VisualExpertInstallation	getInstallPath()
ArrayList<String>	getProjectList()
String	getProjectName()
String	getReportFormat()
String	getReportPath()
boolean	isCreateCodeReviewDocument()
boolean	isCreateReferenceDocument()
boolean	isDoAnalysis()
boolean	isGenerateReport()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, 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

CONSOLE_EXE_NAME

public static final String CONSOLE_EXE_NAME

See Also:

Constant Field Values

Constructor Detail

VisualExpertBuilder

@DataBoundConstructor
public VisualExpertBuilder(String projectName,
                                                 String reportPath,
                                                 String reportFormat,
                                                 Boolean generateReport,
                                                 Boolean doAnalysis,
                                                 Boolean createReferenceDocument,
                                                 Boolean createCodeReviewDocument)

//@param installPath: Visual Expert application (Executable) containing directory path

Parameters:

projectName: - Visual Expert project name (it should be exactly as shown in title bar of Visual Expert)

reportPath - : Specifies the code inspection report file path

reportFormat - : Specifies the code inspection report format

generateReport: - specifies if you would like to generate code inspection report

doAnalysis: - specifies if it should analyze Visual Expert project or not

createReferenceDocument: - specifies if it should generate reference documentation for Visual Expert project or not

createCodeReviewDocument: - specifies if it should generate code review documentation for Visual Expert project or not

Method Detail

getInstallPath

public VisualExpertInstallation getInstallPath()

getReportPath

public String getReportPath()

getReportFormat

public String getReportFormat()

getProjectName

public String getProjectName()

isGenerateReport

public boolean isGenerateReport()

isDoAnalysis

public boolean isDoAnalysis()

isCreateReferenceDocument

public boolean isCreateReferenceDocument()

isCreateCodeReviewDocument

public boolean isCreateCodeReviewDocument()

getProjectList

public ArrayList<String> getProjectList()

getConsoleExePath

public static String getConsoleExePath(String installationfolder)

perform

public void perform(Run<?,?> run,
                    FilePath workspace,
                    Launcher launcher,
                    TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException