edu.umd.cs.findbugs

Class SortedBugCollection

public class SortedBugCollection extends Object implements BugCollection

An implementation of BugCollection that keeps the BugInstances sorted by class (using the native comparison ordering of BugInstance's compareTo() method as a tie-breaker).

Author: David Hovemeyer

See Also: BugInstance

Nested Class Summary
static class	SortedBugCollection.BugInstanceComparator
static class	SortedBugCollection.MultiversionBugInstanceComparator

Constructor Summary
	SortedBugCollection() Constructor.
	SortedBugCollection(Comparator<BugInstance> comparator) Constructor.
	SortedBugCollection(ProjectStats projectStats) Constructor.
	SortedBugCollection(ProjectStats projectStats, Comparator<BugInstance> comparator) Constructor.

Method Summary
boolean	add(BugInstance bugInstance) Add a BugInstance to this BugCollection.
boolean	add(BugInstance bugInstance, boolean updateActiveTime)
void	addAll(Collection<BugInstance> collection) Add a Collection of BugInstances to this BugCollection object.
void	addAll(Collection<BugInstance> collection, boolean updateActiveTime) Add a Collection of BugInstances to this BugCollection object.
void	addAppVersion(AppVersion appVersion)
void	addError(String message) Add an analysis error.
void	addError(String message, Throwable exception)
void	addError(AnalysisError error)
void	addMissingClass(String className)
Iterator<AppVersion>	appVersionIterator()
Iterator<ClassFeatureSet>	classFeatureSetIterator()
void	clearAppVersions()
void	clearBugInstances()
void	clearClassFeatures()
static void	cloneAll(Collection<BugInstance> dest, Collection<BugInstance> source) Clone all of the BugInstance objects in the source Collection and add them to the destination Collection.
void	computeBugHashes()
boolean	contains(BugInstance bugInstance)
SortedBugCollection	createEmptyCollectionWithMetadata()
SortedBugCollection	duplicate()
Iterator<AnalysisError>	errorIterator()
BugInstance	findBug(String instanceHash, String bugType, int lineNumber)
long	getAnalysisTimestamp()
AppVersion	getAppVersionFromSequenceNumber(long target)
ClassFeatureSet	getClassFeatureSet(String className)
Collection<BugInstance>	getCollection()
AppVersion	getCurrentAppVersion() Get the current AppVersion.
BugInstance	getMatching(BugInstance bugInstance)
ProjectStats	getProjectStats()
String	getReleaseName()
long	getSequenceNumber()
String	getSummaryHTML()
long	getTimestamp()
boolean	getWithMessages()
Iterator<BugInstance>	iterator()
Iterator<String>	missingClassIterator()
void	readXML(String fileName, Project project) Read XML data from given file into this object, populating given Project as a side effect.
void	readXML(File file, Project project) Read XML data from given file into this object, populating given Project as a side effect.
void	readXML(InputStream in, Project project, File base) Read XML data from given input stream into this object, populating the Project as a side effect.
void	readXML(InputStream in, Project project)
boolean	remove(BugInstance bugInstance)
void	setAnalysisTimestamp(long timestamp)
void	setAnalysisVersion(String version)
void	setClassFeatureSet(ClassFeatureSet classFeatureSet)
void	setReleaseName(String releaseName)
void	setSequenceNumber(long sequence)
void	setTimestamp(long timestamp)
void	setWithMessages(boolean withMessages)
Document	toDocument(Project project) Convert the BugCollection into a dom4j Document object.
void	writeEpilogue(XMLOutput xmlOutput)
void	writePrologue(XMLOutput xmlOutput, Project project)
void	writeXML(String fileName, Project project) Write this BugCollection to a file as XML.
void	writeXML(File file, Project project) Write this BugCollection to a file as XML.
void	writeXML(OutputStream out, Project project) Write the BugCollection to given output stream as XML.
void	writeXML(XMLOutput xmlOutput, Project project) Write the BugCollection to an XMLOutput object.

Constructor Detail

SortedBugCollection

public SortedBugCollection()

Constructor. Creates an empty object.

SortedBugCollection

public SortedBugCollection(Comparator<BugInstance> comparator)

Constructor. Creates an empty object.

SortedBugCollection

public SortedBugCollection(ProjectStats projectStats)

Constructor. Creates an empty object given an existing ProjectStats.

Parameters: projectStats the ProjectStats

SortedBugCollection

public SortedBugCollection(ProjectStats projectStats, Comparator<BugInstance> comparator)

Constructor. Creates an empty object given an existing ProjectStats.

Parameters: projectStats the ProjectStats comparator to use for sorting bug instances

Method Detail

add

public boolean add(BugInstance bugInstance)

Add a BugInstance to this BugCollection. This just calls add(bugInstance, true).

Parameters: bugInstance the BugInstance

Returns: true if the BugInstance was added, or false if a matching BugInstance was already in the BugCollection

add

public boolean add(BugInstance bugInstance, boolean updateActiveTime)

addAll

public void addAll(Collection<BugInstance> collection)

Add a Collection of BugInstances to this BugCollection object. This just calls add(BugInstance) for each instance in the input collection.

Parameters: collection the Collection of BugInstances to add

addAll

public void addAll(Collection<BugInstance> collection, boolean updateActiveTime)

Add a Collection of BugInstances to this BugCollection object.

Parameters: collection the Collection of BugInstances to add updateActiveTime true if active time of added BugInstances should be updated to match collection: false if not

addAppVersion

public void addAppVersion(AppVersion appVersion)

addError

public void addError(String message)

Add an analysis error.

Parameters: message the error message

addError

public void addError(String message, Throwable exception)

addError

public void addError(AnalysisError error)

addMissingClass

public void addMissingClass(String className)

appVersionIterator

public Iterator<AppVersion> appVersionIterator()

classFeatureSetIterator

public Iterator<ClassFeatureSet> classFeatureSetIterator()

clearAppVersions

public void clearAppVersions()

clearBugInstances

public void clearBugInstances()

clearClassFeatures

public void clearClassFeatures()

cloneAll

public static void cloneAll(Collection<BugInstance> dest, Collection<BugInstance> source)

Clone all of the BugInstance objects in the source Collection and add them to the destination Collection.

Parameters: dest the destination Collection source the source Collection

computeBugHashes

public void computeBugHashes()

contains

public boolean contains(BugInstance bugInstance)

createEmptyCollectionWithMetadata

public SortedBugCollection createEmptyCollectionWithMetadata()

duplicate

public SortedBugCollection duplicate()

errorIterator

public Iterator<AnalysisError> errorIterator()

findBug

public BugInstance findBug(String instanceHash, String bugType, int lineNumber)

getAnalysisTimestamp

public long getAnalysisTimestamp()

getAppVersionFromSequenceNumber

public AppVersion getAppVersionFromSequenceNumber(long target)

getClassFeatureSet

public ClassFeatureSet getClassFeatureSet(String className)

getCollection

public Collection<BugInstance> getCollection()

getCurrentAppVersion

public AppVersion getCurrentAppVersion()

Get the current AppVersion.

getMatching

public BugInstance getMatching(BugInstance bugInstance)

getProjectStats

public ProjectStats getProjectStats()

getReleaseName

public String getReleaseName()

getSequenceNumber

public long getSequenceNumber()

getSummaryHTML

public String getSummaryHTML()

getTimestamp

public long getTimestamp()

getWithMessages

public boolean getWithMessages()

Returns: Returns the withMessages.

iterator

public Iterator<BugInstance> iterator()

missingClassIterator

public Iterator<String> missingClassIterator()

readXML

public void readXML(String fileName, Project project)

Read XML data from given file into this object, populating given Project as a side effect.

Parameters: fileName name of the file to read project the Project

readXML

public void readXML(File file, Project project)

Read XML data from given file into this object, populating given Project as a side effect.

Parameters: file the file project the Project

readXML

public void readXML(InputStream in, Project project, File base)

Read XML data from given input stream into this object, populating the Project as a side effect. An attempt will be made to close the input stream (even if an exception is thrown).

Parameters: in the InputStream project the Project