A B C D E F G H I J K L M P R S T W

A

allowedImportMatches(String) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

analyze(AnalyzerSettings, BannedImportGroups) - Method in interface de.skuzzle.enforcer.restrictimports.analyze.SourceTreeAnalyzer

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

AnalyzeResult - Class in de.skuzzle.enforcer.restrictimports.analyze

AnalyzeResult.Builder - Class in de.skuzzle.enforcer.restrictimports.analyze

AnalyzerSettings - Class in de.skuzzle.enforcer.restrictimports.analyze

Defines context information for the SourceTreeAnalyzer.

AnalyzerSettings.Builder - Class in de.skuzzle.enforcer.restrictimports.analyze

B

BannedImportDefinitionException - Exception in de.skuzzle.enforcer.restrictimports.analyze

Thrown in case a BannedImportGroup was not properly configured by the user.

BannedImportGroup - Class in de.skuzzle.enforcer.restrictimports.analyze

Holds the user configured information of what imports should be banned including all further meta information like base packages, allowed imports and excluded classes.

BannedImportGroup.Builder - Class in de.skuzzle.enforcer.restrictimports.analyze

BannedImportGroupDefinition - Class in de.skuzzle.enforcer.restrictimports.rule

BannedImportGroupDefinition() - Constructor for class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

BannedImportGroups - Class in de.skuzzle.enforcer.restrictimports.analyze

Groups multiple BannedImportGroup objects.

BannedImportGroups.Builder - Class in de.skuzzle.enforcer.restrictimports.analyze

bannedImportsFound() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Returns whether at least one banned import has been found within the analyzed compile OR test source files.

bannedImportsInCompileCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Returns whether at least one banned import has been found within the analyzed compile source code.

bannedImportsInTestCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Returns whether at least one banned import has been found within the analyzed test source code.

basePackageMatches(String) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

build() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult.Builder

build() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings.Builder

build() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

Assembles the BannedImportGroup from this builder.

build() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups.Builder

build() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile.Builder

Creates the MatchedFile instance.

builder() - Static method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

builder() - Static method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

builder() - Static method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

builder() - Static method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups

Builder() - Constructor for class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups.Builder

C

createGroupFromPluginConfiguration() - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

D

de.skuzzle.enforcer.restrictimports - package de.skuzzle.enforcer.restrictimports

de.skuzzle.enforcer.restrictimports.analyze - package de.skuzzle.enforcer.restrictimports.analyze

de.skuzzle.enforcer.restrictimports.formatting - package de.skuzzle.enforcer.restrictimports.formatting

de.skuzzle.enforcer.restrictimports.io - package de.skuzzle.enforcer.restrictimports.io

de.skuzzle.enforcer.restrictimports.parser - package de.skuzzle.enforcer.restrictimports.parser

de.skuzzle.enforcer.restrictimports.parser.lang - package de.skuzzle.enforcer.restrictimports.parser.lang

de.skuzzle.enforcer.restrictimports.rule - package de.skuzzle.enforcer.restrictimports.rule

defaultInstance(Charset) - Static method in interface de.skuzzle.enforcer.restrictimports.parser.ImportStatementParser

Constructs a default instance of the parser which uses the provided charset.

E

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedImport

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

equals(Object) - Method in class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

exclusionMatches(String) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

execute(EnforcerRuleHelper) - Method in class de.skuzzle.enforcer.restrictimports.RestrictImports

Deprecated.

execute(EnforcerRuleHelper) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

F

formatMatches(Collection<Path>, AnalyzeResult) - Method in interface de.skuzzle.enforcer.restrictimports.formatting.MatchFormatter

forSourceFile(Path) - Static method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

Constructs a MatchedFile

G

getAllDirectories() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

Returns the union of AnalyzerSettings.getSrcDirectories() and getTestDirectories.

getAllowedImports() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

getBannedImports() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

getBasePackages() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

getCacheId() - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

getExcludedClasses() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

getFqcn() - Method in class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

getFqcn() - Method in class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

getImportLine() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedImport

getImportName() - Method in class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

getImports() - Method in class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

getInstance() - Static method in interface de.skuzzle.enforcer.restrictimports.analyze.SourceTreeAnalyzer

Creates a new SourceTreeAnalyzer instance.

getInstance() - Static method in interface de.skuzzle.enforcer.restrictimports.formatting.MatchFormatter

getLanguageSupport(String) - Static method in interface de.skuzzle.enforcer.restrictimports.parser.lang.LanguageSupport

Returns the LanguageSupport implementation for the given file extension.

getLine() - Method in class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

getMatchedBy() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

Returns the group that contains the banned import that caused the match in this file.

getMatchedBy() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedImport

getMatchedImports() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

The matches found in this file.

getMatchedString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedImport

getPath() - Method in class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

getReason() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

getSourceFile() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

The java source file containing the matches.

getSourceFileCharset() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

getSrcDirectories() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

getSrcMatches() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Contains all the matches that were found within the analyzed compile source files.

getSupportedFileExtensions() - Method in class de.skuzzle.enforcer.restrictimports.parser.lang.JavaLanguageSupport

getSupportedFileExtensions() - Method in class de.skuzzle.enforcer.restrictimports.parser.lang.KotlinGroovyLanguageSupport

getSupportedFileExtensions() - Method in interface de.skuzzle.enforcer.restrictimports.parser.lang.LanguageSupport

The set of supported file extensions.

getTestDirectories() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

getTestMatches() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Contains all the matches that were found within the analyzed test source files.

H

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedImport

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

hashCode() - Method in class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

hasInput() - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

Determines whether the user modified at least a single field within this definition.

I

ifImportIsBanned(String) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

ImportStatement - Class in de.skuzzle.enforcer.restrictimports.parser

Represents an import statement that has been discovered while parsing a source file.

ImportStatement(String, int) - Constructor for class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

ImportStatementParser - Interface in de.skuzzle.enforcer.restrictimports.parser

For parsing a source file into a ParsedFile.

isCacheable() - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

isLanguageSupported(String) - Static method in interface de.skuzzle.enforcer.restrictimports.parser.lang.LanguageSupport

Determines whether there exists a LanguageSupport implementation for the given extension.

isResultValid(EnforcerRule) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

isStatic() - Method in interface de.skuzzle.enforcer.restrictimports.analyze.PackagePattern

Whether this is a pattern starting with 'static '.

J

JavaLanguageSupport - Class in de.skuzzle.enforcer.restrictimports.parser.lang

JavaLanguageSupport() - Constructor for class de.skuzzle.enforcer.restrictimports.parser.lang.JavaLanguageSupport

K

KotlinGroovyLanguageSupport - Class in de.skuzzle.enforcer.restrictimports.parser.lang

KotlinGroovyLanguageSupport() - Constructor for class de.skuzzle.enforcer.restrictimports.parser.lang.KotlinGroovyLanguageSupport

L

LanguageSupport - Interface in de.skuzzle.enforcer.restrictimports.parser.lang

SPI for plugging in import statement recognition for different languages.

M

matchedBy(BannedImportGroup) - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile.Builder

Sets the group that contained the banned import that caused a match for this file.

MatchedFile - Class in de.skuzzle.enforcer.restrictimports.analyze

Holds the matches that were found within a single source file.

MatchedFile.Builder - Class in de.skuzzle.enforcer.restrictimports.analyze

MatchedImport - Class in de.skuzzle.enforcer.restrictimports.analyze

Represents a single match of a banned import within a java source file.

matches(String) - Method in interface de.skuzzle.enforcer.restrictimports.analyze.PackagePattern

Tests whether the given package name is matched by this package pattern instance.

matches(PackagePattern) - Method in interface de.skuzzle.enforcer.restrictimports.analyze.PackagePattern

Tests whether the given package pattern is matched by this package pattern instance.

MatchFormatter - Interface in de.skuzzle.enforcer.restrictimports.formatting

For formatting the result of the banned import analysis.

P

PackagePattern - Interface in de.skuzzle.enforcer.restrictimports.analyze

Pattern class to match java style package and class names using wild card operators.

parse(String) - Static method in interface de.skuzzle.enforcer.restrictimports.analyze.PackagePattern

Parses the given String into a PackagePattern.

parse(Path, LanguageSupport) - Method in interface de.skuzzle.enforcer.restrictimports.parser.ImportStatementParser

Parses the given source file using the given LanguageSupport implementation to recognize import statements.

parseAll(Collection<String>) - Static method in interface de.skuzzle.enforcer.restrictimports.analyze.PackagePattern

Parses each string of the given collection into a PackagePattern and returns them in a list.

ParsedFile - Class in de.skuzzle.enforcer.restrictimports.parser

Represents a source file that has been parsed for import statements.

ParsedFile(Path, String, String, Collection<ImportStatement>) - Constructor for class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

parseImport(String, int) - Method in class de.skuzzle.enforcer.restrictimports.parser.lang.JavaLanguageSupport

parseImport(String, int) - Method in class de.skuzzle.enforcer.restrictimports.parser.lang.KotlinGroovyLanguageSupport

parseImport(String, int) - Method in interface de.skuzzle.enforcer.restrictimports.parser.lang.LanguageSupport

Extract the package names that this import statement represents.

parsePackage(String) - Method in class de.skuzzle.enforcer.restrictimports.parser.lang.JavaLanguageSupport

parsePackage(String) - Method in class de.skuzzle.enforcer.restrictimports.parser.lang.KotlinGroovyLanguageSupport

parsePackage(String) - Method in interface de.skuzzle.enforcer.restrictimports.parser.lang.LanguageSupport

Parses the given line and returns the declared package

R

RestrictImports - Class in de.skuzzle.enforcer.restrictimports

Deprecated.

Use RestrictImports instead.

RestrictImports() - Constructor for class de.skuzzle.enforcer.restrictimports.RestrictImports

Deprecated.

RestrictImports - Class in de.skuzzle.enforcer.restrictimports.rule

Enforcer rule which restricts the usage of certain packages or classes within a Java code base.

RestrictImports() - Constructor for class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

RuntimeIOException - Exception in de.skuzzle.enforcer.restrictimports.io

Runtime exception replacement for IOException.

RuntimeIOException(String, IOException) - Constructor for exception de.skuzzle.enforcer.restrictimports.io.RuntimeIOException

S

selectGroupFor(String) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups

Selects the BannedImportGroup with the most specific base package matching the given full qualified class name.

setAllowedImport(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setAllowedImport(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setAllowedImports(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setAllowedImports(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setBannedImport(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setBannedImport(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setBannedImports(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setBannedImports(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setBasePackage(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setBasePackage(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setBasePackages(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setBasePackages(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setCommentLineBufferSize(int) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

Deprecated.

setExclusion(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setExclusion(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setExclusions(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setExclusions(List<String>) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setFailBuild(boolean) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setGroups(List<BannedImportGroupDefinition>) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setIncludeTestCode(boolean) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setReason(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.BannedImportGroupDefinition

setReason(String) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

setSkip(boolean) - Method in class de.skuzzle.enforcer.restrictimports.rule.RestrictImports

SourceTreeAnalyzer - Interface in de.skuzzle.enforcer.restrictimports.analyze

Analyzes the whole source tree for matches of banned imports.

srcMatchesByGroup() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Returns the matches that occurred in compile source files grouped by their BannedImportGroup

T

testMatchesByGroup() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

Returns the matches that occurred in test source files grouped by their BannedImportGroup

toString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult

toString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings

toString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup

toString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups

toString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

toString() - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedImport

toString() - Method in class de.skuzzle.enforcer.restrictimports.parser.ImportStatement

toString() - Method in class de.skuzzle.enforcer.restrictimports.parser.ParsedFile

W

withAllowedImports(List<PackagePattern>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withAllowedImports(String...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withBannedImports(List<PackagePattern>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withBannedImports(String...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withBasePackages(List<PackagePattern>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withBasePackages(String...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withExcludedClasses(List<PackagePattern>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withExcludedClasses(String...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withGroup(BannedImportGroup) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups.Builder

withGroup(BannedImportGroup.Builder) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups.Builder

withGroups(Collection<BannedImportGroup>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroups.Builder

withMatchAt(int, String, PackagePattern) - Method in class de.skuzzle.enforcer.restrictimports.analyze.MatchedFile.Builder

Records a matched import within this file.

withMatches(Collection<MatchedFile>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult.Builder

withMatches(MatchedFile.Builder...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult.Builder

withMatchesInTestCode(Collection<MatchedFile>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult.Builder

withMatchesInTestCode(MatchedFile.Builder...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzeResult.Builder

withReason(String) - Method in class de.skuzzle.enforcer.restrictimports.analyze.BannedImportGroup.Builder

withSourceFileCharset(Charset) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings.Builder

withSrcDirectories(Collection<Path>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings.Builder

withSrcDirectories(Path...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings.Builder

withTestDirectories(Collection<Path>) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings.Builder

withTestDirectories(Path...) - Method in class de.skuzzle.enforcer.restrictimports.analyze.AnalyzerSettings.Builder

A B C D E F G H I J K L M P R S T W