Modul edu.hm.hafner.analysis.model

Package edu.hm.hafner.analysis.parser

Klasse JavaDocParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.LookaheadParser

edu.hm.hafner.analysis.parser.AbstractMavenLogParser

edu.hm.hafner.analysis.parser.JavaDocParser

Alle implementierten Schnittstellen:

Serializable

public class JavaDocParser
extends AbstractMavenLogParser

A parser for the ant JavaDoc compiler warnings.

Autor:

Ullrich Hafner

Siehe auch:

• Serialisierte Form

Feldübersicht

Von Klasse geerbte Felder edu.hm.hafner.analysis.LookaheadParser

ANT_TASK

Von Klasse geerbte Felder edu.hm.hafner.analysis.IssueParser

ADDITIONAL_PROPERTIES, CATEGORY, COLUMN_END, COLUMN_START, DESCRIPTION, FILE_NAME, FINGERPRINT, ID, LINE_END, LINE_RANGE_END, LINE_RANGE_START, LINE_RANGES, LINE_START, MESSAGE, MODULE_NAME, ORIGIN, PACKAGE_NAME, SEVERITY, TYPE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
JavaDocParser()	Creates a new instance of JavaDocParser.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected Optional<Issue>	createIssue(Matcher matcher, edu.hm.hafner.util.LookaheadStream lookahead, IssueBuilder builder)	Creates a new issue for the specified pattern.
protected boolean	isLineInteresting(String line)	Returns whether the specified line is interesting.

Von Klasse geerbte Methoden edu.hm.hafner.analysis.parser.AbstractMavenLogParser

getGoal, getModule, hasGoals, preprocessLine

Von Klasse geerbte Methoden edu.hm.hafner.analysis.LookaheadParser

parse, postProcess

Von Klasse geerbte Methoden edu.hm.hafner.analysis.IssueParser

accepts, equalsIgnoreCase, isXmlFile, parseFile

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

JavaDocParser

public JavaDocParser()

Creates a new instance of JavaDocParser.

Methodendetails

isLineInteresting

protected boolean isLineInteresting(String line)

Beschreibung aus Klasse kopiert: LookaheadParser

Returns whether the specified line is interesting. Each interesting line will be matched by the defined regular expression. Here a parser can implement some fast checks (i.e. string or character comparisons) in order to see if a required condition is met. This default implementation does always return true.

Setzt außer Kraft:

isLineInteresting in Klasse LookaheadParser

Parameter:

line - the line to inspect

Gibt zurück:

true if the line should be handed over to the regular expression scanner, false if the line does not contain a warning.

createIssue

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

Beschreibung aus Klasse kopiert: 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.

Angegeben von:

createIssue in Klasse LookaheadParser

Parameter:

matcher - the regular expression matcher

lookahead - the lookahead stream to read additional lines

builder - the issue builder to use

Gibt zurück:

a new annotation for the specified pattern