Package edu.hm.hafner.analysis.parser

Class SphinxBuildParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.LookaheadParser

edu.hm.hafner.analysis.parser.SphinxBuildParser

All Implemented Interfaces:

Serializable

public class SphinxBuildParser
extends LookaheadParser

A parser for the Sphinx build warnings.

Author:

Robert Williams

See Also:

• Serialized Form

Field Summary

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

ANT_TASK

Constructor Summary

Constructors

Constructor	Description
SphinxBuildParser()	Creates a new instance of SphinxBuildParser.

Method Summary

Modifier and Type	Method	Description
protected Optional<Issue>	createIssue(Matcher matcher, edu.hm.hafner.util.LookaheadStream lookahead, IssueBuilder builder)	Creates a new issue for the specified pattern.

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

isLineInteresting, parse, postProcess, preprocessLine

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

accepts, equalsIgnoreCase, isXmlFile, parseFile

Methods inherited from class java.lang.Object

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

Constructor Details

SphinxBuildParser

public SphinxBuildParser()

Creates a new instance of SphinxBuildParser.

Method Details

createIssue

protected Optional<Issue> createIssue(Matcher matcher,
 edu.hm.hafner.util.LookaheadStream lookahead,
 IssueBuilder builder)

Description copied from class: LookaheadParser

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.

Specified by:

createIssue in class LookaheadParser

Parameters:

matcher - the regular expression matcher

lookahead - the lookahead stream to read additional lines

builder - the issue builder to use

Returns:

a new annotation for the specified pattern