de.skuzzle.enforcer.restrictimports.api

Interface SourceTreeAnalyzer

public interface SourceTreeAnalyzer

Analyzes the whole source tree for matches of banned imports.

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
Map<String,List<Match>>	analyze(Stream<Path> roots, BannedImportGroup group) Analyzes all java classes found recursively in the given root directories for matches of banned imports.
void	checkGroupConsistency(BannedImportGroup group) Checks whether the given group is consistent with respect to all user input.

Method Detail

checkGroupConsistency

void checkGroupConsistency(BannedImportGroup group)
                    throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Checks whether the given group is consistent with respect to all user input.

Parameters:

group - The group to check.

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException - If the group is not consistent.

analyze

Map<String,List<Match>> analyze(Stream<Path> roots,
                                BannedImportGroup group)

Analyzes all java classes found recursively in the given root directories for matches of banned imports.

Parameters:

roots - The source directories.

group - The banned import.

Returns:

A map of file names to the matches found within that file.