edu.hm.hafner.analysis

Class RegexpParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.RegexpParser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RegexpDocumentParser, RegexpLineParser

public abstract class RegexpParser
extends IssueParser

Parses an input stream for compiler warnings or issues from a static analysis tool using the provided regular expression. Normally, this base class should not directly be extended. Rather extend from the base classes RegexpDocumentParser or RegexpLineParser.

Author:

Ullrich Hafner

See Also:

RegexpDocumentParser, RegexpLineParser, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ANT_TASK Pattern identifying an ant task debug output prefix.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegexpParser(String pattern, boolean useMultiLine) Creates a new instance of RegexpParser.

Method Summary

Modifier and Type	Method and Description
protected IssueBuilder	configureIssueBuilder(IssueBuilder builder) Optionally configures the issue builder instance.
protected abstract Optional<Issue>	createIssue(Matcher matcher, IssueBuilder builder) Creates a new issue for the specified pattern.
protected void	findIssues(String content, Report report) Parses the specified string content using a regular expression and creates a set of new issues for each match.

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

ANT_TASK

protected static final String ANT_TASK

Pattern identifying an ant task debug output prefix.

See Also:

Constant Field Values

Constructor Detail

RegexpParser

protected RegexpParser(String pattern,
                       boolean useMultiLine)

Creates a new instance of RegexpParser.

Parameters:

pattern - pattern of compiler warnings.

useMultiLine - Enables multi line mode. In multi line mode the expressions ^ and $ match just after or just before, respectively, a line terminator or the end of the input sequence. By default these

Method Detail

findIssues

protected void findIssues(String content,
                          Report report)
                   throws ParsingException,
                          ParsingCanceledException

Parses the specified string content using a regular expression and creates a set of new issues for each match. The new issues are added to the provided set of Report.

Parameters:

content - the content to scan

report - the report to add the new issues to

Throws:

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

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

configureIssueBuilder

protected IssueBuilder configureIssueBuilder(IssueBuilder builder)

Optionally configures the issue builder instance.

Parameters:

builder - the build to configure

Returns:

the builder

createIssue

protected abstract Optional<Issue> createIssue(Matcher matcher,
                                               IssueBuilder builder)
                                        throws ParsingException

Creates a new issue for the specified pattern. This method is called for each matching line in the specified file. If a match is a false positive, then return Optional.empty() to ignore this warning.

Parameters:

matcher - the regular expression matcher

builder - the issue builder to use

Returns:

a new annotation for the specified pattern

Throws:

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