edu.hm.hafner.analysis

Class AbstractParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.AbstractParser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractDryParser, AbstractViolationAdapter, AjcParser, CcmParser, CheckStyleParser, EclipseXMLParser, FxCopParser, GendarmeParser, IdeaInspectionParser, JcReportParser, LintParser, PmdParser, RegexpParser, SonarQubeParser, StyleCopParser, TaglistParser

public abstract class AbstractParser
extends IssueParser

Parses an input stream for issues of a specific static analysis tool and returns the found issues. If your parser is based on a regular expression you can extend from the existing base classes RegexpLineParser or RegexpDocumentParser. Each parser accepts a pre-preprocessor of the input lines. Here you can remove all debugging lines that might be printed by the used build tool.

Author:

Ullrich Hafner

See Also:

RegexpLineParser, RegexpDocumentParser, CppLintParser, EclipseParser, StyleCopParser, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEPRECATION Category for warnings due to usage of deprecate API.
static String	PROPRIETARY_API Category for warnings due to the usage of proprietary API.

Constructor Summary

Constructors

Constructor and Description
AbstractParser()

Method Summary

Modifier and Type	Method and Description
String	getFileName() Returns the absolute path of the file that is parsed.
protected String	guessCategory(String message) Classifies the warning message: tries to guess a category from the warning message.
protected String	guessCategoryIfEmpty(String category, String message) Returns a category for the current warning.
Report	parse(Path file, Charset charset, Function<String,String> preProcessor) Parses the specified file for issues.
Report	parse(Reader reader) Parses the specified input stream for issues.
abstract Report	parse(Reader reader, Function<String,String> preProcessor) Parses the specified input stream for issues.
protected int	parseInt(String lineNumber) Converts a string line number to an integer value.

Methods inherited from class edu.hm.hafner.analysis.IssueParser

accepts, isXmlFile, parse

Methods inherited from class java.lang.Object

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

Field Detail

DEPRECATION

public static final String DEPRECATION

Category for warnings due to usage of deprecate API.

See Also:

Constant Field Values

PROPRIETARY_API

public static final String PROPRIETARY_API

Category for warnings due to the usage of proprietary API.

See Also:

Constant Field Values

Constructor Detail

AbstractParser

public AbstractParser()

Method Detail

getFileName

public String getFileName()

Returns the absolute path of the file that is parsed.

Returns:

the file name

parse

public Report parse(Path file,
                    Charset charset,
                    Function<String,String> preProcessor)
             throws ParsingException,
                    ParsingCanceledException

Description copied from class: IssueParser

Parses the specified file for issues.

Specified by:

parse in class IssueParser

Parameters:

file - the file to parse

charset - the encoding to use when reading files

preProcessor - pre processes each input line before handing it to the actual parser

Returns:

the issues

Throws:

ParsingException - Signals that during parsing a non recoverable error has been occurred

ParsingCanceledException - Signals that the parsing has been aborted by the user

parse

public abstract Report parse(Reader reader,
                             Function<String,String> preProcessor)
                      throws ParsingCanceledException,
                             ParsingException

Parses the specified input stream for issues.

Parameters:

reader - the reader to get the text from

preProcessor - pre processes each input line before handing it to the actual parser

Returns:

the issues

Throws:

ParsingException - Signals that during parsing a non recoverable error has been occurred

ParsingCanceledException - Signals that the parsing has been aborted by the user

parse

public Report parse(Reader reader)
             throws ParsingCanceledException,
                    ParsingException

Parses the specified input stream for issues. Input lines are not pre processed.

Parameters:

reader - the reader to get the text from

Returns:

the parsed issues

Throws:

ParsingException - Signals that during parsing a non recoverable error has been occurred

ParsingCanceledException - Signals that the parsing has been aborted by the user

parseInt

protected int parseInt(@CheckForNull
                       String lineNumber)

Converts a string line number to an integer value. If the string is not a valid line number, then 0 is returned which indicates an issue at the top of the file.

Parameters:

lineNumber - the line number (as a string)

Returns:

the line number

guessCategory

protected String guessCategory(@CheckForNull
                               String message)

Classifies the warning message: tries to guess a category from the warning message.

Parameters:

message - the message to check

Returns:

warning category, empty string if unknown

guessCategoryIfEmpty

protected String guessCategoryIfEmpty(@CheckForNull
                                      String category,
                                      @CheckForNull
                                      String message)

Returns a category for the current warning. If the provided category is not empty, then a capitalized string is returned. Otherwise the category is obtained from the specified message text.

Parameters:

category - the warning category (might be empty)

message - the warning message

Returns:

the actual category