Class SourceFinder

java.lang.Object

edu.umd.cs.findbugs.ba.SourceFinder

All Implemented Interfaces:

AutoCloseable

public class SourceFinder
extends Object
implements AutoCloseable

Class to open input streams on source files. It maintains a "source path", which is like a classpath, but for finding source files instead of class files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SourceFinder.BlockingSourceRepository
private static class	SourceFinder.Cache	Cache of SourceFiles.
private static class	SourceFinder.DirectorySourceRepository	A directory containing source files.
private static class	SourceFinder.InMemorySourceRepository
private static interface	SourceFinder.SourceRepository	A repository of source files.
(package private) static class	SourceFinder.ZipSourceRepository	A zip or jar archive containing source files.

Field Summary

Fields

Modifier and Type	Field	Description
private SourceFinder.Cache	cache
private static final int	CACHE_SIZE
private static final boolean	DEBUG
private Project	project
private List<SourceFinder.SourceRepository>	repositoryList

Constructor Summary

Constructors

Constructor	Description
SourceFinder(Project project)

Method Summary

Modifier and Type	Method	Description
void	close()
SourceFile	findSourceFile(SourceLineAnnotation source)
SourceFile	findSourceFile(String packageName, String fileName)	Open a source file in given package.
Optional<URI>	getBase(SourceLineAnnotation sourceLineAnnotation)
Optional<URI>	getBase(String fileName)
static String	getCanonicalName(SourceLineAnnotation source)
static String	getCanonicalName(String packageName, String fileName)
static String	getOrGuessSourceFile(SourceLineAnnotation source)
static String	getPlatformName(SourceLineAnnotation source)
static String	getPlatformName(String packageName, String fileName)
Project	getProject()
boolean	hasSourceFile(SourceLineAnnotation source)
boolean	hasSourceFile(String packageName, String fileName)
(package private) SourceFinder.SourceRepository	makeInMemorySourceRepository(String url)
(package private) SourceFinder.SourceRepository	makeJarURLConnectionSourceRepository(String url)
private InputStream	open(String url)
InputStream	openSource(SourceLineAnnotation source)
InputStream	openSource(String packageName, String fileName)	Open an input stream on a source file in given package.
private void	setProject(Project project)
void	setSourceBaseList(Iterable<String> sourceBaseList)	Set the list of source directories.

Methods inherited from class Object

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

Field Details

DEBUG

private static final boolean DEBUG

CACHE_SIZE

private static final int CACHE_SIZE

See Also:

• Constant Field Values

repositoryList

private List<SourceFinder.SourceRepository> repositoryList

cache

private SourceFinder.Cache cache

project

private Project project

Constructor Details

SourceFinder

public SourceFinder(Project project)

Method Details

makeInMemorySourceRepository

SourceFinder.SourceRepository makeInMemorySourceRepository(String url)

makeJarURLConnectionSourceRepository

SourceFinder.SourceRepository makeJarURLConnectionSourceRepository(String url)
                                                            throws IOException

Throws:

IOException

open

private InputStream open(String url)
                  throws IOException

Parameters:

url -

Returns:

Throws:

IOException

MalformedURLException

getProject

public Project getProject()

Returns:

Returns the project.

setSourceBaseList

public void setSourceBaseList(Iterable<String> sourceBaseList)

Set the list of source directories.

openSource

public InputStream openSource(String packageName,
 String fileName)
                       throws IOException

Open an input stream on a source file in given package.

Parameters:

packageName - the name of the package containing the class whose source file is given

fileName - the unqualified name of the source file

Returns:

an InputStream on the source file

Throws:

IOException - if a matching source file cannot be found

openSource

public InputStream openSource(SourceLineAnnotation source)
                       throws IOException

Throws:

IOException

findSourceFile

public SourceFile findSourceFile(SourceLineAnnotation source)
                          throws IOException

Throws:

IOException

findSourceFile

public SourceFile findSourceFile(String packageName,
 String fileName)
                          throws IOException

Open a source file in given package.

Parameters:

packageName - the name of the package containing the class whose source file is given

fileName - the unqualified name of the source file

Returns:

the source file

Throws:

IOException - if a matching source file cannot be found

getPlatformName

public static String getPlatformName(String packageName,
 String fileName)

getPlatformName

public static String getPlatformName(SourceLineAnnotation source)

getCanonicalName

public static String getCanonicalName(SourceLineAnnotation source)

getCanonicalName

public static String getCanonicalName(String packageName,
 String fileName)

getOrGuessSourceFile

public static String getOrGuessSourceFile(SourceLineAnnotation source)

hasSourceFile

public boolean hasSourceFile(SourceLineAnnotation source)

hasSourceFile

public boolean hasSourceFile(String packageName,
 String fileName)

setProject

private void setProject(Project project)

close

public void close()

Specified by:

close in interface AutoCloseable

getBase

public Optional<URI> getBase(SourceLineAnnotation sourceLineAnnotation)

getBase

public Optional<URI> getBase(String fileName)