hudson.plugins.violations
Class ViolationsPublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Recorder
              hudson.plugins.violations.ViolationsPublisher

All Implemented Interfaces:

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

public class ViolationsPublisher
extends hudson.tasks.Recorder

Generats HTML and XML reports from checkstyle, pmd and findbugs report xml files.

Author:

Peter Reilly

Nested Class Summary

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

static hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

DESCRIPTOR The descriptor for this publisher - used in project config page.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

ViolationsPublisher()

Method Summary

ViolationsConfig	getConfig() Get the configuration object for this violations publisher.
hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>	getDescriptor() Get the descriptor.
ViolationsConfig	getOldConfig() Get a copy of the configuration.
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project) Create a project action for a project.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Called by hudson at the end of a build.

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

getProjectActions, prebuild

Field Detail

DESCRIPTOR

@Extension
public static final hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> DESCRIPTOR

The descriptor for this publisher - used in project config page.

Constructor Detail

ViolationsPublisher

public ViolationsPublisher()

Method Detail

getConfig

public ViolationsConfig getConfig()

Get the configuration object for this violations publisher.

Returns:

the config.

getOldConfig

public ViolationsConfig getOldConfig()

Get a copy of the configuration. This is used to configure a new publisher in the config.jelly script.

Returns:

a copy o the config.

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws java.lang.InterruptedException,
                       java.io.IOException

Called by hudson at the end of a build.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build - the build

launcher - the launcher

listener - for reporting errors

Returns:

true always.

Throws:

java.lang.InterruptedException - if user cancels the operation

java.io.IOException - if problem parsing the xml files

getProjectAction

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

Create a project action for a project.

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

project - the project to create the action for.

Returns:

the created violations project action.

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

getDescriptor

public hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()

Get the descriptor.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Recorder

Returns:

the violations publisher descriptor.