hudson.plugins.pmd.util.model
Class WorkspaceFile

java.lang.Object
  hudson.plugins.pmd.util.model.AnnotationContainer
      hudson.plugins.pmd.util.model.WorkspaceFile

All Implemented Interfaces:

AnnotationProvider, java.io.Serializable, java.lang.Comparable<AnnotationContainer>

public class WorkspaceFile
extends AnnotationContainer

A serializable Java Bean class representing a file in the Hudson workspace.

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

WorkspaceFile(java.lang.String fileName)
Creates a new instance of WorkspaceFile.

Method Summary

int	compareTo(AnnotationContainer other)
java.lang.String	getShortName() Returns a readable name of this workspace file without path prefix.
java.lang.String	getTempName() Returns a file name for a temporary file that will hold the contents of the source.

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

addAnnotation, addAnnotations, addAnnotations, containsCategory, containsFile, containsModule, containsPackage, containsType, equals, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getCategories, getCategory, getContainer, getFile, getFile, getFiles, getHighAnnotations, getHighPriority, getLowAnnotations, getLowPriority, getModule, getModule, getModules, getName, getNormalAnnotations, getNormalPriority, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getPackage, getPackage, getPackageCategoryName, getPackages, getToolTip, getType, getTypes, 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

WorkspaceFile

public WorkspaceFile(java.lang.String fileName)

Creates a new instance of WorkspaceFile.

Parameters:

fileName - absolute path of this file

Method Detail

getShortName

public java.lang.String getShortName()

Returns a readable name of this workspace file without path prefix.

Returns:

a readable name of this workspace file.

getTempName

public java.lang.String getTempName()

Returns a file name for a temporary file that will hold the contents of the source.

Returns:

the temporary name

compareTo

public int compareTo(AnnotationContainer other)

Specified by:

compareTo in interface java.lang.Comparable<AnnotationContainer>

Overrides:

compareTo in class AnnotationContainer