hudson.plugins.pmd
Class ModuleDetail

java.lang.Object
  hudson.plugins.pmd.util.model.AnnotationContainer
      hudson.plugins.pmd.AbstractWarningsDetail
          hudson.plugins.pmd.ModuleDetail

All Implemented Interfaces:

hudson.model.ModelObject, AnnotationProvider, java.io.Serializable

public class ModuleDetail
extends AbstractWarningsDetail

Result object to visualize the package statistics of a module.

See Also:

Serialized Form

Constructor Summary

ModuleDetail(hudson.model.AbstractBuild<?,?> owner, MavenModule module)
Creates a new instance of ModuleDetail.

Method Summary

void	doPackageStatistics(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Generates a PNG image for high/normal/low distribution of a Java package.
java.lang.String	getDisplayName()
java.lang.Object	getDynamic(java.lang.String link, org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Returns the dynamic result of this PMD detail view.
MavenModule	getModule() Returns the maven module.
java.util.Collection<JavaPackage>	getPackages() Returns the packages of this module.
java.lang.String	getToolTip(java.lang.String packageName) Returns a tooltip showing the distribution of priorities for the selected package.
boolean	isSinglePackageModule() Returns whether this module contains just one Java package.

Methods inherited from class hudson.plugins.pmd.AbstractWarningsDetail

createDetailGraph, getOwner, isCurrent

Methods inherited from class hudson.plugins.pmd.util.model.AnnotationContainer

addAnnotation, addAnnotations, addAnnotations, annotationAdded, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getToolTip, hasAnnotations, hasAnnotations, hasAnnotations, rebuildPriorities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleDetail

public ModuleDetail(hudson.model.AbstractBuild<?,?> owner,
                    MavenModule module)

Creates a new instance of ModuleDetail.

Parameters:

owner - current build as owner of this action.

module - the module to show the details for

Method Detail

getDisplayName

public java.lang.String getDisplayName()

getModule

public MavenModule getModule()

Returns the maven module.

Returns:

the maven module

getPackages

public java.util.Collection<JavaPackage> getPackages()

Returns the packages of this module.

Returns:

the packages of this module

isSinglePackageModule

public boolean isSinglePackageModule()

Returns whether this module contains just one Java package. In this case we show the warnings statistics instead of package statistics.

Returns:

true if this project contains just one Java package

doPackageStatistics

public final void doPackageStatistics(org.kohsuke.stapler.StaplerRequest request,
                                      org.kohsuke.stapler.StaplerResponse response)
                               throws java.io.IOException

Generates a PNG image for high/normal/low distribution of a Java package.

Parameters:

request - Stapler request

response - Stapler response

Throws:

java.io.IOException - in case of an error

getDynamic

public java.lang.Object getDynamic(java.lang.String link,
                                   org.kohsuke.stapler.StaplerRequest request,
                                   org.kohsuke.stapler.StaplerResponse response)

Returns the dynamic result of this PMD detail view. Depending on the number of packages, one of the following detail objects is returned:

• A detail object for a single workspace file (if the module contains only one package).
• A package detail object for a specified package (in any other case).

Parameters:

link - the link to identify the sub page to show

request - Stapler request

response - Stapler response

Returns:

the dynamic result of the PMD analysis (detail page for a package).

getToolTip

public java.lang.String getToolTip(java.lang.String packageName)

Returns a tooltip showing the distribution of priorities for the selected package.

Parameters:

packageName - the package to show the distribution for

Returns:

a tooltip showing the distribution of priorities