Package de.skuzzle.enforcer.restrictimports.analyze

Class MatchedFile

java.lang.Object

de.skuzzle.enforcer.restrictimports.analyze.MatchedFile

public final class MatchedFile
extends Object

Holds the matches that were found within a single java source file. Instances can be constructed using forSourceFile(Path).

Author:

Simon Taddiken

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatchedFile.Builder

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static MatchedFile.Builder	forSourceFile(Path sourceFile)	Constructs a MatchedFile
BannedImportGroup	getMatchedBy()	Returns the group that contains the banned import that caused the match in this file.
List<MatchedImport>	getMatchedImports()	The matches found in this file.
Path	getSourceFile()	The java source file containing the matches.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

forSourceFile

public static MatchedFile.Builder forSourceFile(Path sourceFile)

Constructs a MatchedFile

Parameters:

sourceFile - The path to the java source file.

Returns:

A Builder for further configuration of the MatchedFile instance.

getSourceFile

public Path getSourceFile()

The java source file containing the matches.

Returns:

The java source file.

getMatchedImports

public List<MatchedImport> getMatchedImports()

The matches found in this file.

Returns:

The matches.

getMatchedBy

public BannedImportGroup getMatchedBy()

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

Returns:

The group.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object