edu.hm.hafner.analysis

Class RegexpDocumentParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.AbstractParser

edu.hm.hafner.analysis.RegexpParser

edu.hm.hafner.analysis.RegexpDocumentParser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DoxygenParser, DrMemoryParser, EclipseParser, GhsMultiParser, GnuFortranParser, NagFortranParser, YuiCompressorParser

public abstract class RegexpDocumentParser
extends RegexpParser

Parses an input stream as a whole document for compiler warnings or issues from a static analysis tool using the provided regular expression.

Author:

Ullrich Hafner

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.hm.hafner.analysis.RegexpParser

ANT_TASK, FALSE_POSITIVE

Fields inherited from class edu.hm.hafner.analysis.AbstractParser

DEPRECATION, PROPRIETARY_API

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Report	parse(Reader reader, Function<String,String> preProcessor) Parses the specified input stream for issues.

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

createIssue, findIssues

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

getFileName, guessCategory, guessCategoryIfEmpty, parse, parse, parseInt

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

parse

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexpDocumentParser

protected RegexpDocumentParser(String pattern,
                               boolean useMultiLine)

Creates a new instance of RegexpDocumentParser.

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 expressions only match at the beginning and the end of the

Method Detail

parse

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

Description copied from class: AbstractParser

Parses the specified input stream for issues.

Specified by:

parse in class AbstractParser

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:

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

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