hudson.plugins.checkstyle.util
Class PackageDetail

java.lang.Object
  hudson.plugins.checkstyle.util.model.AnnotationContainer
      hudson.plugins.checkstyle.util.AbstractAnnotationsDetail
          hudson.plugins.checkstyle.util.PackageDetail

All Implemented Interfaces:

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

public class PackageDetail
extends AbstractAnnotationsDetail

Result object to visualize the package statistics of a module.

Author:

Ulli Hafner

See Also:

Serialized Form

Constructor Summary

PackageDetail(hudson.model.AbstractBuild<?,?> owner, JavaPackage javaPackage, java.lang.String header)
Creates a new instance of ModuleDetail.

Method Summary

java.lang.String	getDisplayName()
WorkspaceFile	getFile(java.lang.String fileName) Gets the file with the given name.
java.util.Collection<WorkspaceFile>	getFiles() Gets the files of this container that have annotations.
java.lang.String	getHeader() Returns the header for the detail screen.
JavaPackage	getPackage() Returns the maven module.

Methods inherited from class hudson.plugins.checkstyle.util.AbstractAnnotationsDetail

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

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

addAnnotation, addAnnotations, addAnnotations, addFile, annotationAdded, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getName, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getPackageCategoryName, getToolTip, hasAnnotations, hasAnnotations, hasAnnotations, rebuildMappings, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageDetail

public PackageDetail(hudson.model.AbstractBuild<?,?> owner,
                     JavaPackage javaPackage,
                     java.lang.String header)

Creates a new instance of ModuleDetail.

Parameters:

owner - current build as owner of this action.

javaPackage - the package to show the details for

header - header to be shown on detail page

Method Detail

getHeader

public java.lang.String getHeader()

Returns the header for the detail screen.

Returns:

the header

getDisplayName

public java.lang.String getDisplayName()

getPackage

public JavaPackage getPackage()

Returns the maven module.

Returns:

the maven module

getFiles

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

Gets the files of this container that have annotations.

Overrides:

getFiles in class AnnotationContainer

Returns:

the files with annotations

getFile

public WorkspaceFile getFile(java.lang.String fileName)

Gets the file with the given name.

Overrides:

getFile in class AnnotationContainer

Parameters:

fileName - the short name of the file

Returns:

the file with the given name