Package com.exasol.errorcodecrawlermavenplugin.crawler

Class ErrorMessageDeclarationCrawler

java.lang.Object

com.exasol.errorcodecrawlermavenplugin.crawler.ErrorMessageDeclarationCrawler

public class ErrorMessageDeclarationCrawler
extends Object

Crawler that reads invocations of ExaError.messageBuilder(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorMessageDeclarationCrawler.Result	Result of crawl(List)

Constructor Summary

Constructors

Constructor	Description
ErrorMessageDeclarationCrawler(Path rootProjectDirectory, Path projectDirectory, List<Path> classPath, int javaSourceVersion, List<String> excludedFiles)	Create a new instance of ErrorMessageDeclarationCrawler.

Method Summary

Modifier and Type	Method	Description
ErrorMessageDeclarationCrawler.Result	crawl(List<Path> pathsToCrawl)	Crawl error codes for a file / folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ErrorMessageDeclarationCrawler

public ErrorMessageDeclarationCrawler(Path rootProjectDirectory,
 Path projectDirectory,
 List<Path> classPath,
 int javaSourceVersion,
 List<String> excludedFiles)

Create a new instance of ErrorMessageDeclarationCrawler.

Parameters:

rootProjectDirectory - root project directory of multimodule project to which all paths are relative (equivalent to projectDirectory for single-module project)

projectDirectory - project directory to which all paths as relative for paths in messages

classPath - classPath with the dependencies of the classes to crawl. In the unit-tests for some reason this can be empty. Probably Spoon then picks the class path of this project. When run from a jar the classpath is however required.

javaSourceVersion - java source version / language level of the project

excludedFiles - list of glob expressions for files to exclude from validation

Method Details

crawl

public ErrorMessageDeclarationCrawler.Result crawl(List<Path> pathsToCrawl)

Crawl error codes for a file / folder.

Parameters:

pathsToCrawl - file(s) / folder(s) to crawl.

Returns:

ErrorMessageDeclarationCrawler.Result with found error codes and findings