Class ClassPathBuilder

java.lang.Object

edu.umd.cs.findbugs.classfile.impl.ClassPathBuilder

All Implemented Interfaces:

IClassPathBuilder

public class ClassPathBuilder
extends Object
implements IClassPathBuilder

Implementation of IClassPathBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ClassPathBuilder.DiscoveredCodeBase	A codebase discovered during classpath building.
(package private) static class	ClassPathBuilder.WorkListItem	Worklist item.

Field Summary

Fields

Modifier and Type	Field	Description
private final LinkedList<ClassDescriptor>	appClassList
private final IClassFactory	classFactory
private static final boolean	DEBUG
private final LinkedList<ClassPathBuilder.DiscoveredCodeBase>	discoveredCodeBaseList
private final Map<String, ClassPathBuilder.DiscoveredCodeBase>	discoveredCodeBaseMap
private final IErrorLogger	errorLogger
private static final boolean	NO_PARSE_CLASS_NAMES
private final LinkedList<ClassPathBuilder.WorkListItem>	projectWorkList
private boolean	scanNestedArchives
private static final boolean	VERBOSE

Constructor Summary

Constructors

Constructor	Description
ClassPathBuilder(IClassFactory classFactory, IErrorLogger errorLogger)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addCodeBase(ICodeBaseLocator locator, boolean isApplication)	Add a project codebase.
private void	addToWorkList(LinkedList<ClassPathBuilder.WorkListItem> workList, ClassPathBuilder.WorkListItem itemToAdd)	Add a worklist item to the worklist.
private void	addWorkListItemsForClasspath(LinkedList<ClassPathBuilder.WorkListItem> workList, String path)	Add worklist items from given system classpath.
private void	addWorkListItemsForExtDir(LinkedList<ClassPathBuilder.WorkListItem> workList, String extDir)	Add worklist items from given extensions directory.
void	build(IClassPath classPath, IClassPathBuilderProgress progress)	Build the classpath.
private LinkedList<ClassPathBuilder.WorkListItem>	buildFindBugsAnnotationCodebaseList()	Create a worklist that will add the FindBugs lib/annotations.jar to the classpath.
private LinkedList<ClassPathBuilder.WorkListItem>	buildFindBugsFullJarCodebaseList()
private LinkedList<ClassPathBuilder.WorkListItem>	buildJSR305AnnotationsCodebaseList()	Create a worklist that will add the FindBugs lib/jsr305.jar to the classpath.
private LinkedList<ClassPathBuilder.WorkListItem>	buildSystemCodebaseList()
private LinkedList<ClassPathBuilder.WorkListItem>	createFindBugsLibWorkList(String jarFileName)
private void	dumpCodeBaseList(Iterator<? extends ICodeBase> i, String desc)
List<ClassDescriptor>	getAppClassList()	Get the list of application classes discovered while scanning the classpath.
private static boolean	isJava9orLater()
private void	locateCodebasesRequiredForAnalysis(IClassPath classPath, IClassPathBuilderProgress progress)	Make an effort to find the codebases containing any files required for analysis.
private boolean	matchesJarFile(String entry, String jarFileName)
private void	parseClassName(ICodeBaseEntry entry)	Attempt to parse data of given resource in order to divine the real name of the class contained in the resource.
private boolean	probeCodeBaseForResource(ClassPathBuilder.DiscoveredCodeBase discoveredCodeBase, String resourceName)	Probe a codebase to see if a given source exists in that code base.
private void	processWorkList(IClassPath classPath, LinkedList<ClassPathBuilder.WorkListItem> workList, IClassPathBuilderProgress progress)	Process classpath worklist items.
private boolean	runningFindBugsFullJar()
private void	scanCodebase(IClassPath classPath, LinkedList<ClassPathBuilder.WorkListItem> workList, ClassPathBuilder.DiscoveredCodeBase discoveredCodeBase)	Scan given codebase in order to check the codebase for nested archives (adding any found to the worklist) build a list of class resources found in the codebase
private void	scanJarManifestForClassPathEntries(LinkedList<ClassPathBuilder.WorkListItem> workList, ICodeBase codeBase)	Check a codebase for a Jar manifest to examine for Class-Path entries.
void	scanNestedArchives(boolean scanNestedArchives)	Set whether or not nested archives should be scanned.

Methods inherited from class Object

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

Field Details

VERBOSE

private static final boolean VERBOSE

DEBUG

private static final boolean DEBUG

NO_PARSE_CLASS_NAMES

private static final boolean NO_PARSE_CLASS_NAMES

classFactory

private final IClassFactory classFactory

errorLogger

private final IErrorLogger errorLogger

projectWorkList

private final LinkedList<ClassPathBuilder.WorkListItem> projectWorkList

discoveredCodeBaseList

private final LinkedList<ClassPathBuilder.DiscoveredCodeBase> discoveredCodeBaseList

discoveredCodeBaseMap

private final Map<String, ClassPathBuilder.DiscoveredCodeBase> discoveredCodeBaseMap

appClassList

private final LinkedList<ClassDescriptor> appClassList

scanNestedArchives

private boolean scanNestedArchives

Constructor Details

ClassPathBuilder

ClassPathBuilder(IClassFactory classFactory,
 IErrorLogger errorLogger)

Constructor.

Parameters:

classFactory - the class factory

errorLogger - the error logger

Method Details

addCodeBase

public void addCodeBase(ICodeBaseLocator locator,
 boolean isApplication)

Description copied from interface: IClassPathBuilder

Add a project codebase.

Specified by:

addCodeBase in interface IClassPathBuilder

Parameters:

locator - locator for project codebase

isApplication - true if the codebase is an application codebase, false otherwise

scanNestedArchives

public void scanNestedArchives(boolean scanNestedArchives)

Description copied from interface: IClassPathBuilder

Set whether or not nested archives should be scanned. This should be called before the build() method is called.

Specified by:

scanNestedArchives in interface IClassPathBuilder

Parameters:

scanNestedArchives - true if nested archives should be scanned, false otherwise

build

public void build(IClassPath classPath,
 IClassPathBuilderProgress progress)
           throws CheckedAnalysisException,
IOException,
InterruptedException

Description copied from interface: IClassPathBuilder

Build the classpath.

Specified by:

build in interface IClassPathBuilder

Parameters:

classPath - IClassPath object to build

progress - IClassPathBuilderProgress callback

Throws:

IOException

InterruptedException

CheckedAnalysisException

locateCodebasesRequiredForAnalysis

private void locateCodebasesRequiredForAnalysis(IClassPath classPath,
 IClassPathBuilderProgress progress)
                                         throws InterruptedException,
IOException,
ResourceNotFoundException

Make an effort to find the codebases containing any files required for analysis.

Throws:

InterruptedException

IOException

ResourceNotFoundException

runningFindBugsFullJar

private boolean runningFindBugsFullJar()

buildFindBugsFullJarCodebaseList

private LinkedList<ClassPathBuilder.WorkListItem> buildFindBugsFullJarCodebaseList()

probeCodeBaseForResource

private boolean probeCodeBaseForResource(ClassPathBuilder.DiscoveredCodeBase discoveredCodeBase,
 String resourceName)

Probe a codebase to see if a given source exists in that code base.

Parameters:

resourceName - name of a resource

Returns:

true if the resource exists in the codebase, false if not

dumpCodeBaseList

private void dumpCodeBaseList(Iterator<? extends ICodeBase> i,
 String desc)
                       throws InterruptedException

Throws:

InterruptedException

buildSystemCodebaseList

private LinkedList<ClassPathBuilder.WorkListItem> buildSystemCodebaseList()

isJava9orLater

private static boolean isJava9orLater()

buildFindBugsAnnotationCodebaseList

private LinkedList<ClassPathBuilder.WorkListItem> buildFindBugsAnnotationCodebaseList()

Create a worklist that will add the FindBugs lib/annotations.jar to the classpath.

buildJSR305AnnotationsCodebaseList

private LinkedList<ClassPathBuilder.WorkListItem> buildJSR305AnnotationsCodebaseList()

Create a worklist that will add the FindBugs lib/jsr305.jar to the classpath.

createFindBugsLibWorkList

private LinkedList<ClassPathBuilder.WorkListItem> createFindBugsLibWorkList(String jarFileName)

matchesJarFile

private boolean matchesJarFile(String entry,
 String jarFileName)

addWorkListItemsForClasspath

private void addWorkListItemsForClasspath(LinkedList<ClassPathBuilder.WorkListItem> workList,
 String path)

Add worklist items from given system classpath.

Parameters:

workList - the worklist

path - a system classpath

addWorkListItemsForExtDir

private void addWorkListItemsForExtDir(LinkedList<ClassPathBuilder.WorkListItem> workList,
 String extDir)

Add worklist items from given extensions directory.

Parameters:

workList - the worklist

extDir - an extensions directory

processWorkList

private void processWorkList(IClassPath classPath,
 LinkedList<ClassPathBuilder.WorkListItem> workList,
 IClassPathBuilderProgress progress)
                      throws InterruptedException,
IOException,
ResourceNotFoundException

Process classpath worklist items. We will attempt to find all nested archives and Class-Path entries specified in Jar manifests. This should give us as good an idea as possible of all of the classes available (and which are part of the application).

Parameters:

workList - the worklist to process

progress - IClassPathBuilderProgress callback

Throws:

InterruptedException

IOException

ResourceNotFoundException

scanCodebase

private void scanCodebase(IClassPath classPath,
 LinkedList<ClassPathBuilder.WorkListItem> workList,
 ClassPathBuilder.DiscoveredCodeBase discoveredCodeBase)
                   throws InterruptedException

Scan given codebase in order to

• check the codebase for nested archives (adding any found to the worklist)
• build a list of class resources found in the codebase

Parameters:

workList - the worklist

discoveredCodeBase - the codebase to scan

Throws:

InterruptedException

parseClassName

private void parseClassName(ICodeBaseEntry entry)

Attempt to parse data of given resource in order to divine the real name of the class contained in the resource.

Parameters:

entry - the resource

scanJarManifestForClassPathEntries

private void scanJarManifestForClassPathEntries(LinkedList<ClassPathBuilder.WorkListItem> workList,
 ICodeBase codeBase)
                                         throws IOException

Check a codebase for a Jar manifest to examine for Class-Path entries.

Parameters:

workList - the worklist

codeBase - the codebase for examine for a Jar manifest

Throws:

IOException

addToWorkList

private void addToWorkList(LinkedList<ClassPathBuilder.WorkListItem> workList,
 ClassPathBuilder.WorkListItem itemToAdd)

Add a worklist item to the worklist. This method maintains the invariant that all of the worklist items representing application codebases appear before all of the worklist items representing auxiliary codebases.

Parameters:

workList - the worklist

itemToAdd - the worklist item to add

getAppClassList

public List<ClassDescriptor> getAppClassList()

Description copied from interface: IClassPathBuilder

Get the list of application classes discovered while scanning the classpath.

Specified by:

getAppClassList in interface IClassPathBuilder

Returns:

list of application classes