Package org.jacoco.report

Interface ISourceFileLocator

All Known Implementing Classes:

DirectorySourceFileLocator, InputStreamSourceFileLocator, MultiSourceFileLocator

public interface ISourceFileLocator

Interface to look-up source files that will be included with the report.

Method Summary

Modifier and Type	Method	Description
java.io.Reader	getSourceFile(java.lang.String packageName, java.lang.String fileName)	Tries to locate the given source file and opens a reader with the appropriate encoding.
int	getTabWidth()	Returns number of blank characters that represent a tab in source code.

Method Detail

getSourceFile

java.io.Reader getSourceFile(java.lang.String packageName,
                             java.lang.String fileName)
                      throws java.io.IOException

Tries to locate the given source file and opens a reader with the appropriate encoding.

Parameters:

packageName - VM name of the package

fileName - name of the source file

Returns:

reader if the file could be located, null otherwise

Throws:

java.io.IOException - in case of problems while opening the file

getTabWidth

int getTabWidth()

Returns number of blank characters that represent a tab in source code.

Returns:

tab width as number of blanks