hudson.plugins.findbugs.util
Class AbstractAnnotationsDetail

java.lang.Object
  hudson.plugins.findbugs.util.model.AnnotationContainer
      hudson.plugins.findbugs.util.AbstractAnnotationsDetail

All Implemented Interfaces:

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

Direct Known Subclasses:

FixedWarningsDetail, ModuleDetail, NewWarningsDetail, PackageDetail, PrioritiesDetail

public abstract class AbstractAnnotationsDetail
extends AnnotationContainer
implements hudson.model.ModelObject

Base class for annotation detail objects. Instances of this class could be used for Hudson Stapler objects that contain a subset of annotations.

Author:

Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.plugins.findbugs.util.model.AnnotationContainer

AnnotationContainer.Hierarchy

Constructor Summary

AbstractAnnotationsDetail(hudson.model.AbstractBuild<?,?> owner, java.util.Collection<FileAnnotation> annotations, java.lang.String name, AnnotationContainer.Hierarchy hierarchy)
Creates a new instance of AbstractWarningsDetail.

Method Summary

protected void	createDetailGraph(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response, AnnotationProvider detailObject, int upperBound) Creates a detail graph for the specified detail object.
void	doModuleStatistics(org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Generates a PNG image for high/normal/low distribution of a maven module.
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.
protected hudson.model.ModelObject	getDynamic(java.lang.String link) Returns the dynamic result of this module detail view.
java.lang.Object	getDynamic(java.lang.String link, org.kohsuke.stapler.StaplerRequest request, org.kohsuke.stapler.StaplerResponse response) Returns the dynamic result of this module detail view.
java.lang.String	getLocalizedPriority(java.lang.String priorityName) Returns a localized priority name.
hudson.model.AbstractBuild<?,?>	getOwner() Returns the build as owner of this object.
Priority[]	getPriorities() Returns all possible priorities.
boolean	isCurrent() Returns whether this build is the last available build.
boolean	isSingleModuleProject() Returns whether this project contains just one maven module.
boolean	isSinglePackageProject() Returns whether we only have a single package.

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

addAnnotation, addAnnotations, addAnnotations, containsFile, containsModule, containsPackage, getAnnotation, getAnnotation, getAnnotationBound, getAnnotations, getAnnotations, getAnnotations, getChildren, getFile, getFiles, getModule, getModules, getName, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getPackage, getPackageCategoryName, getPackages, getToolTip, hasAnnotations, hasAnnotations, hasAnnotations, rebuildMappings, setHierarchy, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Constructor Detail

AbstractAnnotationsDetail

public AbstractAnnotationsDetail(hudson.model.AbstractBuild<?,?> owner,
                                 java.util.Collection<FileAnnotation> annotations,
                                 java.lang.String name,
                                 AnnotationContainer.Hierarchy hierarchy)

Creates a new instance of AbstractWarningsDetail.

Parameters:

owner - current build as owner of this object.

annotations - the set of warnings represented by this object

name - the name of this object

Method Detail

getOwner

public final hudson.model.AbstractBuild<?,?> getOwner()

Returns the build as owner of this object.

Returns:

the owner

isCurrent

public final boolean isCurrent()

Returns whether this build is the last available build.

Returns:

true if this build is the last available build

createDetailGraph

protected final void createDetailGraph(org.kohsuke.stapler.StaplerRequest request,
                                       org.kohsuke.stapler.StaplerResponse response,
                                       AnnotationProvider detailObject,
                                       int upperBound)
                                throws java.io.IOException

Creates a detail graph for the specified detail object.

Parameters:

request - Stapler request

response - Stapler response

detailObject - the detail object to compute the graph for

upperBound - the upper bound of all tasks

Throws:

java.io.IOException - in case of an error

getLocalizedPriority

public java.lang.String getLocalizedPriority(java.lang.String priorityName)

Returns a localized priority name.

Parameters:

priorityName - priority as String value

Returns:

localized priority name

getDynamic

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

Returns the dynamic result of this module 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 this module detail view

getDynamic

protected hudson.model.ModelObject getDynamic(java.lang.String link)

Returns the dynamic result of this module detail view. Depending on the link value the sub-class could return a special detail object. If there is no such one, then null must be returned. In this case, the link will be interpreted as source detail of the specified annotation.

Parameters:

link - the link to identify the sub page to show, or null if the source detail should be shown

Returns:

the dynamic result of this module detail view

getPriorities

public Priority[] getPriorities()

Returns all possible priorities.

Returns:

all priorities

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

isSinglePackageProject

public boolean isSinglePackageProject()

Returns whether we only have a single package. In this case the module and package statistics are suppressed and only the tasks are shown.

Returns:

true for single module projects

doModuleStatistics

public final void doModuleStatistics(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 maven module.

Parameters:

request - Stapler request

response - Stapler response

Throws:

java.io.IOException - in case of an error

isSingleModuleProject

public boolean isSingleModuleProject()

Returns whether this project contains just one maven module. In this case we show package statistics instead of module statistics.

Returns:

true if this project contains just one maven module