de.skuzzle.enforcer.restrictimports.parser.lang

Interface LanguageSupport

All Known Implementing Classes:

JavaLanguageSupport, KotlinGroovyLanguageSupport

public interface LanguageSupport

SPI for plugging in import statement recognition for different languages. Implementations will be looked up using java's ServiceLoader.

Author:

Simon Taddiken

Method Summary

Modifier and Type	Method and Description
static Optional<LanguageSupport>	getLanguageSupport(String extension) Returns the LanguageSupport implementation for the given file extension.
Set<String>	getSupportedFileExtensions() The set of supported file extensions.
static boolean	isLanguageSupported(String extension) Determines whether there exists a LanguageSupport implementation for the given extension.
List<ImportStatement>	parseImport(String importLine, int lineNumber) Extract the package names that this import statement represents.
Optional<String>	parsePackage(String line) Parses the given line and returns the declared package

Method Detail

getLanguageSupport

static Optional<LanguageSupport> getLanguageSupport(String extension)

Returns the LanguageSupport implementation for the given file extension.

Parameters:

extension - The extension.

Returns:

The LanguageSupport implementation or an empty optional if none was found.

isLanguageSupported

static boolean isLanguageSupported(String extension)

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

Parameters:

extension - The extension.

Returns:

Whether such implementation exists.

getSupportedFileExtensions

Set<String> getSupportedFileExtensions()

The set of supported file extensions. Extensions returned here are case insensitive and may or may not start with a '.' (dot).

Returns:

The set of file extensions.

parsePackage

Optional<String> parsePackage(String line)

Parses the given line and returns the declared package

Parameters:

line - Line in the source file

Returns:

The package declared

parseImport

List<ImportStatement> parseImport(String importLine,
                                  int lineNumber)

Extract the package names that this import statement represents. As some languages allow to specify multiple imports in a single line, this method returns a list.

e.g. import java.util.List; The above should return java.util.List in a Java source file.

Parameters:

importLine - Line in the source file

lineNumber - The line number of the import.

Returns:

Fully qualified package name that this import represents