com.boxuk.jenkins.jslint

Class JSLintBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.boxuk.jenkins.jslint.JSLintBuilder

All Implemented Interfaces:

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

public class JSLintBuilder
extends hudson.tasks.Builder

A Builder for JSLint. Takes parameters to determine filesets to include/exclude and creates output in Checkstyle format.

When a build is performed, the perform(AbstractBuild, Launcher, BuildListener) method will be invoked.

Author:

Gavin Davies

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSLintBuilder.DescriptorImpl Implementation of an extension point.

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
JSLintBuilder(String includePattern, String excludePattern, String logfile, String arguments) Fields in config.jelly must match the parameter names in the "DataBoundConstructor".

Method Summary

Methods

Modifier and Type	Method and Description
String	getArguments()
String	getExcludePattern()
String	getIncludePattern()
String	getLogfile()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) Perform this JSLint operation.

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, 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, prebuild

Constructor Detail

JSLintBuilder

@DataBoundConstructor
public JSLintBuilder(String includePattern,
                                  String excludePattern,
                                  String logfile,
                                  String arguments)

Fields in config.jelly must match the parameter names in the "DataBoundConstructor".

Parameters:

includePattern - files to include - apache ant filter

excludePattern - files to exclude - apache ant filter

logfile - xml location to log to

Method Detail

getIncludePattern

public final String getIncludePattern()

Returns:

The include pattern - apache ant style filter

getExcludePattern

public final String getExcludePattern()

Returns:

The exclude pattern - apache ant style filter

getLogfile

public final String getLogfile()

Returns:

Where to put the XML log

getArguments

public final String getArguments()

Returns:

User arguments

perform

public final boolean perform(hudson.model.AbstractBuild build,
              hudson.Launcher launcher,
              hudson.model.BuildListener listener)
                      throws InterruptedException,
                             IOException

Perform this JSLint operation.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build - The build

launcher - Launcher

listener - Listener

Returns:

True if it worked, else false

Throws:

IOException - Can be thrown if can't read files

InterruptedException - Can be thrown if build interrupted