hudson.plugins.findbugs.util.model
Class WorkspaceFile

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

All Implemented Interfaces:

AnnotationProvider, java.io.Serializable

public class WorkspaceFile
extends AnnotationContainer

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

Author:

Ulli Hafner

See Also:

Serialized Form

Constructor Summary

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

Method Summary

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	getShortName() Returns a readable name of this workspace file without path prefix.

Methods inherited from class hudson.plugins.findbugs.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

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.

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