edu.umd.cs.findbugs.classfile

Interface IClassPathBuilder

All Known Implementing Classes:

ClassPathBuilder

public interface IClassPathBuilder

Build a classpath. Takes a list of project codebases and

• Scans them for nested and referenced codebases
• Builds a list of application class descriptors
• Adds system codebases

Author:

David Hovemeyer

Method Summary

Methods

Modifier and Type	Method and Description
void	addCodeBase(ICodeBaseLocator locator, boolean isApplication) Add a project codebase.
void	build(IClassPath classPath, IClassPathBuilderProgress progress) Build the classpath.
List<ClassDescriptor>	getAppClassList() Get the list of application classes discovered while scanning the classpath.
void	scanNestedArchives(boolean scanNestedArchives) Set whether or not nested archives should be scanned.

Method Detail

addCodeBase

void addCodeBase(ICodeBaseLocator locator,
               boolean isApplication)

Add a project codebase.

Parameters:

locator - locator for project codebase

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

scanNestedArchives

void scanNestedArchives(boolean scanNestedArchives)

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

Parameters:

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

build

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

Build the classpath.

Parameters:

classPath - IClassPath object to build

progress - IClassPathBuilderProgress callback

Throws:

ResourceNotFoundException

IOException

InterruptedException

CheckedAnalysisException

getAppClassList

List<ClassDescriptor> getAppClassList()

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

Returns:

list of application classes