Package com.exasol.errorcodecrawlermavenplugin.config

Class ErrorCodeConfig

java.lang.Object

com.exasol.errorcodecrawlermavenplugin.config.ErrorCodeConfig

public class ErrorCodeConfig
extends Object

This class represents the contents of the error code config file. It is created by ErrorCodeConfigReader.

Constructor Summary

Constructors

Constructor	Description
ErrorCodeConfig(Map<String,SingleErrorCodeConfig> errorTags)	Create a new instance of ErrorCodeConfig.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getErrorTagForPackage(String packageName)	Get the error tag configured for a specific java package.
int	getHighestIndexForErrorTag(String errorTag)	Get the highest index of an error code.
List<String>	getPackagesForErrorTag(String errorTag)	Get packages for a specific error tag.
boolean	hasErrorTag(String errorTag)	Check if a specific error tag is declared in the configuration file.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ErrorCodeConfig

public ErrorCodeConfig(Map<String,SingleErrorCodeConfig> errorTags)

Create a new instance of ErrorCodeConfig.

Parameters:

errorTags - error tag entries

Method Details

getErrorTagForPackage

public Optional<String> getErrorTagForPackage(String packageName)

Get the error tag configured for a specific java package.

Parameters:

packageName - name of the package

Returns:

corresponding error tag

getPackagesForErrorTag

public List<String> getPackagesForErrorTag(String errorTag)

Get packages for a specific error tag.

Parameters:

errorTag - error tag e.g: EXA-TEST

Returns:

list of packages that can declare this error code

hasErrorTag

public boolean hasErrorTag(String errorTag)

Check if a specific error tag is declared in the configuration file.

Parameters:

errorTag - error tag to check

Returns:

true if the tag was declared.

getHighestIndexForErrorTag

public int getHighestIndexForErrorTag(String errorTag)

Get the highest index of an error code.

Parameters:

errorTag - error code

Returns:

highest index (according to the config file)

toString

public String toString()

Overrides:

toString in class Object