Interface ISourceFileLocator

All Known Implementing Classes:
AntFilesLocator, AntResourcesLocator, DirectorySourceFileLocator, InputStreamSourceFileLocator, MultiSourceFileLocator, ReportSupport.NoSourceLocator, ReportSupport.SourceFileCollection
public interface ISourceFileLocator
Interface to look-up source files that will be included with the report.

  • Method Summary

    Modifier and Type
    Method
    Description
    Reader
    getSourceFile(String packageName, 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 Details

    • getSourceFile

      Reader getSourceFile(String packageName, String fileName) throws 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:
      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