com.atlassian.maven.plugin.clover.internal.scanner

Interface CloverSourceScanner

All Known Implementing Classes:

AbstractSourceScanner, MainSourceScanner, TestSourceScanner

public interface CloverSourceScanner

Scans source roots and return list of files to instrument.

Method Summary

Modifier and Type	Method and Description
Map<String,String[]>	getExcludedFiles() Returns the list of excluded files that we'll need to copy.
Map<String,String[]>	getSourceFilesToInstrument() Returns the list of source files to instrument taking into account the includes and excludes specified by the user.
Map<String,String[]>	getSourceFilesToInstrument(LanguageFileFilter languageFileFilter, boolean skipGroovySourceDirectory) Returns the list of source files to instrument taking into account the includes and excludes specified by the user and additionaly taking into account a programming language.
boolean	isSourceRootForLanguage(String sourceRoot, com.atlassian.clover.spi.lang.Language language)

Method Detail

getSourceFilesToInstrument

Map<String,String[]> getSourceFilesToInstrument()

Returns the list of source files to instrument taking into account the includes and excludes specified by the user. The Map is indexed on source roots.

Returns:

Map<String, String[]> = Map(source root, files)

getSourceFilesToInstrument

Map<String,String[]> getSourceFilesToInstrument(LanguageFileFilter languageFileFilter,
                                                boolean skipGroovySourceDirectory)

Returns the list of source files to instrument taking into account the includes and excludes specified by the user and additionaly taking into account a programming language. The Map is indexed on source roots.

Parameters:

languageFileFilter - extra filter (in addition to includes/excludes) based on programming language

skipGroovySourceDirectory - if true then don't list source files which are located in the source directory 'native' for groovy language

Returns:

Map<String, String[]> = Map(source root, files)

getExcludedFiles

Map<String,String[]> getExcludedFiles()

Returns the list of excluded files that we'll need to copy. This is required as otherwise the excluded files won't be in the new Clover source directory and thus won't be compiled by the compile plugin. This will lead to compilation errors if any other Java file depends on any of them. The Map is indexed on source roots.

Returns:

Map<String, String[]> = Map(source root, files)

isSourceRootForLanguage

boolean isSourceRootForLanguage(String sourceRoot,
                                com.atlassian.clover.spi.lang.Language language)