hudson.plugins.pmd.util
Class ModuleDetail

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

All Implemented Interfaces:

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

public class ModuleDetail
extends AbstractAnnotationsDetail

Result object to visualize the package statistics of a module.

See Also:

Serialized Form

Constructor Summary

ModuleDetail(hudson.model.AbstractBuild<?,?> owner, MavenModule module, java.lang.String header)
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()
AbstractAnnotationsDetail	getDynamic(java.lang.String link) Returns a package detail object if there are more packages available.
java.util.Collection<WorkspaceFile>	getFiles() Gets the files of this module that have annotations.
java.lang.String	getHeader() Returns the header for the detail screen.
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.util.AbstractAnnotationsDetail

createDetailGraph, getDynamic, getLocalizedPriority, getOwner, getPriorities, getTitle, isCurrent

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

addAnnotation, addAnnotations, addAnnotations, annotationAdded, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getPackageCategoryName, 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,
                    java.lang.String header)

Creates a new instance of ModuleDetail.

Parameters:

owner - current build as owner of this action.

module - the module to show the details for

header - header to be shown on detail page

Method Detail

getDisplayName

public java.lang.String getDisplayName()

getHeader

public java.lang.String getHeader()

Returns the header for the detail screen.

Returns:

the header

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 AbstractAnnotationsDetail getDynamic(java.lang.String link)

Returns a package detail object if there are more packages available. Otherwise a null value is returned.

Overrides:

getDynamic in class AbstractAnnotationsDetail

Parameters:

link - the link to identify the sub page to show

Returns:

the dynamic result of this module detail view

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

getFiles

public java.util.Collection<WorkspaceFile> getFiles()

Gets the files of this module that have annotations.

Returns:

the files with annotations