Package edu.umd.cs.findbugs

Class PackageStats

java.lang.Object

edu.umd.cs.findbugs.PackageStats

All Implemented Interfaces:

XMLWriteable

public class PackageStats
extends java.lang.Object
implements XMLWriteable

Class to store package bug statistics.

Author:

Mike Fagan, Jay Dunning

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PackageStats.ClassStats

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALL_ERRORS
static java.lang.String	ELEMENT_NAME

Constructor Summary

Constructors

Constructor	Description
PackageStats(java.lang.String packageName)
PackageStats(java.lang.String packageName, int numClasses, int size)

Method Summary

Modifier and Type	Method	Description
void	addClass(PackageStats.ClassStats classStats)
void	addClass(java.lang.String name, boolean isInterface, int size)	Deprecated. Use addClass(String,String,boolean,int) instead
void	addClass(java.lang.String name, java.lang.String sourceFile, boolean isInterface, int size)
void	addError(BugInstance bug)
void	clearBugCounts()
int	getBugsAtPriority(int p)
java.util.Collection<PackageStats.ClassStats>	getClassStats()
PackageStats.ClassStats	getClassStatsOrNull(java.lang.String name)
int	getNumClasses()
java.lang.String	getPackageName()
java.util.Collection<PackageStats.ClassStats>	getSortedClassStats()
int	getTotalBugs()
void	purgeClassesThatDontMatch(java.util.regex.Pattern classPattern)
void	recomputeFromClassStats()
void	setNumClasses(int numClasses)
int	size()
java.lang.String	toString()
static void	writeBugPriorities(XMLOutput xmlOutput, int[] bugs)	Add priority attributes to a started tag.
void	writeXML(XMLOutput xmlOutput)	Write this object to given XMLOutput.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

See Also:

Constant Field Values

ALL_ERRORS

public static final int ALL_ERRORS

See Also:

Constant Field Values

Constructor Detail

PackageStats

public PackageStats(java.lang.String packageName)

PackageStats

public PackageStats(java.lang.String packageName,
                    int numClasses,
                    int size)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getClassStats

public java.util.Collection<PackageStats.ClassStats> getClassStats()

getTotalBugs

public int getTotalBugs()

size

public int size()

getBugsAtPriority

public int getBugsAtPriority(int p)

getClassStatsOrNull

public PackageStats.ClassStats getClassStatsOrNull(java.lang.String name)

addError

public void addError(BugInstance bug)

addClass

@Deprecated
public void addClass(java.lang.String name,
                     boolean isInterface,
                     int size)

Deprecated.

Use addClass(String,String,boolean,int) instead

addClass

public void addClass(java.lang.String name,
                     java.lang.String sourceFile,
                     boolean isInterface,
                     int size)

addClass

public void addClass(PackageStats.ClassStats classStats)

getPackageName

public java.lang.String getPackageName()

getNumClasses

public int getNumClasses()

setNumClasses

public void setNumClasses(int numClasses)

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws java.io.IOException

Description copied from interface: XMLWriteable

Write this object to given XMLOutput.

Specified by:

writeXML in interface XMLWriteable

Parameters:

xmlOutput - the XMLOutput for the document

Throws:

java.io.IOException

getSortedClassStats

public java.util.Collection<PackageStats.ClassStats> getSortedClassStats()

writeBugPriorities

public static void writeBugPriorities(XMLOutput xmlOutput,
                                      int[] bugs)
                               throws java.io.IOException

Add priority attributes to a started tag. Each priority at offset n, where n > 0, is output using attribute priority_n if the value at offset n is greater than zero.

Parameters:

xmlOutput - an output stream for which startTag has been called but stopTag has not.

bugs - an array for which the element at offset n is the number of bugs for priority n.

Throws:

java.io.IOException

recomputeFromClassStats

public void recomputeFromClassStats()

clearBugCounts

public void clearBugCounts()

purgeClassesThatDontMatch

public void purgeClassesThatDontMatch(java.util.regex.Pattern classPattern)

Parameters:

classPattern -