Package edu.umd.cs.findbugs

Class BugRanker

java.lang.Object

edu.umd.cs.findbugs.BugRanker

public class BugRanker
extends java.lang.Object

Bug rankers are used to compute a bug rank for each bug instance. Bug ranks 1-20 are for bugs that are visible to users. Bug rank 1 is more the most relevant/scary bugs. A bug rank greater than 20 is for issues that should not be shown to users. The following bug rankers may exist:

• core bug ranker (loaded from etc/bugrank.txt)
• a bug ranker for each plugin (loaded from <plugin>/etc/bugrank.txt)
• A global adjustment ranker (loaded from plugins/adjustBugrank.txt)

A bug ranker is comprised of a list of bug patterns, bug kinds and bug categories. For each, either an absolute or relative bug rank is provided. A relative rank is one preceded by a + or -. For core bug detectors, the bug ranker search order is:

• global adjustment bug ranker
• core bug ranker

For third party plugins, the bug ranker search order is:

• global adjustment bug ranker
• plugin adjustment bug ranker
• core bug ranker

The overall search order is

• Bug patterns, in search order across bug rankers
• Bug kinds, in search order across bug rankers
• Bug categories, in search order across bug rankers

Search stops at the first absolute bug rank found, and the result is the sum of all of relative bug ranks plus the final absolute bug rank. Since all bug categories are defined by the core bug ranker, we should always find an absolute bug rank.

See Also:

BugRankCategory, Priorities, Confidence

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BugRanker.Scorer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ADJUST_FILENAME
private BugRanker.Scorer	bugCategories
private BugRanker.Scorer	bugKinds
private BugRanker.Scorer	bugPatterns
static java.lang.String	FILENAME
private static org.slf4j.Logger	LOG
private static AnalysisLocal<java.util.HashMap<BugPattern,java.lang.Integer>>	rankForBugPattern
static int	VISIBLE_RANK_MAX	Maximum value for user visible ranks (least relevant)
static int	VISIBLE_RANK_MIN	Minimum value for user visible ranks (most relevant)

Constructor Summary

Constructors

Constructor	Description
BugRanker(@Nullable java.net.URL u)

Method Summary

Modifier and Type	Method	Description
private static int	adjustRank(int patternRank, int priority)
static int	findRank(BugInstance bug)
static int	findRank(BugPattern bugPattern, int priority)
static int	findRank(BugPattern pattern, @Nullable DetectorFactory detectorFactory)
private static int	findRankUnknownPlugin(BugPattern pattern)
private static BugRanker	getCoreRanker()
private static int	priorityAdjustment(int priority)
private static int	rankBugPattern(BugPattern bugPattern, BugRanker... rankers)
static void	trimToMaxRank(BugCollection origCollection, int maxRank)

Methods inherited from class java.lang.Object

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

Field Detail

VISIBLE_RANK_MAX

public static final int VISIBLE_RANK_MAX

Maximum value for user visible ranks (least relevant)

See Also:

Constant Field Values

VISIBLE_RANK_MIN

public static final int VISIBLE_RANK_MIN

Minimum value for user visible ranks (most relevant)

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

bugPatterns

private final BugRanker.Scorer bugPatterns

bugKinds

private final BugRanker.Scorer bugKinds

bugCategories

private final BugRanker.Scorer bugCategories

FILENAME

public static final java.lang.String FILENAME

See Also:

Constant Field Values

ADJUST_FILENAME

public static final java.lang.String ADJUST_FILENAME

See Also:

Constant Field Values

rankForBugPattern

private static AnalysisLocal<java.util.HashMap<BugPattern,java.lang.Integer>> rankForBugPattern

Constructor Detail

BugRanker

BugRanker(@Nullable java.net.URL u)
   throws java.io.IOException

Parameters:

u - may be null. In this case, a default value will be used for all bugs

Throws:

java.io.IOException

Method Detail

priorityAdjustment

private static int priorityAdjustment(int priority)

adjustRank

private static int adjustRank(int patternRank,
                              int priority)

rankBugPattern

private static int rankBugPattern(BugPattern bugPattern,
                                  BugRanker... rankers)

getCoreRanker

private static BugRanker getCoreRanker()

findRank

public static int findRank(BugInstance bug)

findRank

public static int findRank(BugPattern bugPattern,
                           int priority)

findRank

public static int findRank(BugPattern pattern,
                           @Nullable DetectorFactory detectorFactory)

findRankUnknownPlugin

private static int findRankUnknownPlugin(BugPattern pattern)

trimToMaxRank

public static void trimToMaxRank(BugCollection origCollection,
                                 int maxRank)