hudson.plugins.pmd.util
Class FileDetail

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

All Implemented Interfaces:

hudson.model.ModelObject, AnnotationProvider, java.io.Serializable, java.lang.Comparable<AnnotationContainer>

public class FileDetail
extends AbstractAnnotationsDetail

Result object to visualize the package statistics of a module.

Author:

Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

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

AnnotationContainer.Hierarchy

Constructor Summary

FileDetail(hudson.model.AbstractBuild<?,?> owner, WorkspaceFile file, java.lang.String defaultEncoding, java.lang.String header)
Creates a new instance of ModuleDetail.

Method Summary

java.lang.String	getDisplayName()
WorkspaceFile	getFile(int hashCode) Gets the file with the given hash code.
WorkspaceFile	getFile(java.lang.String name) 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.

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

getDefaultEncoding, getDynamic, getLocalizedPriority, getOwner, getPriorities, isCurrent

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

addAnnotation, addAnnotations, addAnnotations, compareTo, containsCategory, containsFile, containsModule, containsPackage, containsType, equals, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getCategories, getCategory, getCategory, getContainer, getHighAnnotations, getHighPriority, getLowAnnotations, getLowPriority, getModule, getModule, getModules, getName, getNormalAnnotations, getNormalPriority, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfHighAnnotations, getNumberOfLowAnnotations, getNumberOfNormalAnnotations, getPackage, getPackage, getPackageCategoryName, getPackages, getToolTip, getType, getType, getTypes, getUpperBound, hasAnnotations, hasAnnotations, hasAnnotations, hashCode, hasNoAnnotations, hasNoAnnotations, hasNoAnnotations, rebuildMappings, setHierarchy, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDetail

public FileDetail(hudson.model.AbstractBuild<?,?> owner,
                  WorkspaceFile file,
                  java.lang.String defaultEncoding,
                  java.lang.String header)

Creates a new instance of ModuleDetail.

Parameters:

owner - current build as owner of this action.

file - the file to show the details for

defaultEncoding - the default encoding to be used when reading and parsing files

header - header to be shown on detail page

Method Detail

getHeader

public java.lang.String getHeader()

Returns the header for the detail screen.

Overrides:

getHeader in class AbstractAnnotationsDetail

Returns:

the header

getDisplayName

public java.lang.String getDisplayName()

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(int hashCode)

Gets the file with the given hash code.

Overrides:

getFile in class AnnotationContainer

Parameters:

hashCode - the hash code of the file

Returns:

the file with the given name

getFile

public WorkspaceFile getFile(java.lang.String name)

Gets the file with the given name.

Overrides:

getFile in class AnnotationContainer

Parameters:

name - the short name of the file

Returns:

the file with the given name