hudson.plugins.tasks
Class AbstractTasksResult

java.lang.Object
  hudson.plugins.tasks.util.model.AnnotationContainer
      hudson.plugins.tasks.AbstractTasksResult

All Implemented Interfaces:

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

Direct Known Subclasses:

ModuleDetail, PackageDetail

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

Base class for tasks detail objects.

See Also:

Serialized Form

Constructor Summary

AbstractTasksResult(hudson.model.AbstractBuild<?,?> owner, java.util.Collection<FileAnnotation> annotations, java.lang.String high, java.lang.String normal, java.lang.String low)
Creates a new instance of AbstractTasksDetail.

Method Summary

protected void	annotationAdded(FileAnnotation annotation) Called if the specified annotation has been added to this container.
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.
java.util.Collection<java.lang.String>	getAvailablePriorities() Returns the defined priorities.
hudson.model.AbstractBuild<?,?>	getOwner() Returns the current build as owner of this result object.
java.lang.String	getPackageCategoryName() Returns the package category name for the scanned files.
java.util.List<java.lang.String>	getPriorities() Returns the actually used priorities.
java.lang.String	getTags(Priority priority) Returns the tags for the specified priority.
java.lang.String	getTags(java.lang.String priority) Returns the tags for the specified priority.
boolean	isCurrent() Returns whether this result object belongs to the last build.

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

addAnnotation, addAnnotations, addAnnotations, 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

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Constructor Detail

AbstractTasksResult

public AbstractTasksResult(hudson.model.AbstractBuild<?,?> owner,
                           java.util.Collection<FileAnnotation> annotations,
                           java.lang.String high,
                           java.lang.String normal,
                           java.lang.String low)

Creates a new instance of AbstractTasksDetail.

Parameters:

owner - the current build as owner of this result object

high - tag identifiers indicating high priority

normal - tag identifiers indicating normal priority

low - tag identifiers indicating low priority

annotations - all the files that contain tasks

Method Detail

annotationAdded

protected final void annotationAdded(FileAnnotation annotation)

Called if the specified annotation has been added to this container. Subclasses may override this default empty implementation.

Overrides:

annotationAdded in class AnnotationContainer

Parameters:

annotation - the added annotation

getPackageCategoryName

public java.lang.String getPackageCategoryName()

Returns the package category name for the scanned files. Currently, only java and c# files are supported.

Returns:

the package category name for the scanned files

getOwner

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

Returns the current build as owner of this result object.

Returns:

the owner of this details object

isCurrent

public final boolean isCurrent()

Returns whether this result object belongs to the last build.

Returns:

true if this result belongs to the last build

getPriorities

public java.util.List<java.lang.String> getPriorities()

Returns the actually used priorities.

Returns:

the actually used priorities.

getAvailablePriorities

public java.util.Collection<java.lang.String> getAvailablePriorities()

Returns the defined priorities.

Returns:

the defined priorities.

getTags

public final java.lang.String getTags(java.lang.String priority)

Returns the tags for the specified priority.

Parameters:

priority - the priority

Returns:

the tags for the specified priority

getTags

public final java.lang.String getTags(Priority priority)

Returns the tags for the specified priority.

Parameters:

priority - the priority

Returns:

the tags for the specified priority

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