edu.hm.hafner.analysis.parser.dry

Class AbstractDryParser<T>

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.AbstractParser

edu.hm.hafner.analysis.parser.dry.AbstractDryParser<T>

Type Parameters:

T - the type of the parsed warnings

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CpdParser, DupFinderParser, SimianParser

public abstract class AbstractDryParser<T>
extends AbstractParser

A duplication parser template for Digester based parsers.

See Also:

Serialized Form

Field Summary

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

DEPRECATION, PROPRIETARY_API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDryParser(int highThreshold, int normalThreshold) Creates a new instance of AbstractDryParser.

Method Summary

Modifier and Type	Method and Description
protected abstract void	configureParser(org.apache.commons.digester3.Digester digester) Configures the Digester parser.
protected abstract Report	convertDuplicationsToIssues(List<T> duplications) Converts the parsed duplications from the original format to an Report instance.
protected Severity	getPriority(int lines) Returns the priority of the warning.
Report	parse(Reader reader, Function<String,String> preProcessor) Parses the specified input stream for issues.

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

getFileName, guessCategory, guessCategoryIfEmpty, parse, parse, parseInt

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

Constructor Detail

AbstractDryParser

protected AbstractDryParser(int highThreshold,
                            int normalThreshold)

Creates a new instance of AbstractDryParser.

Parameters:

highThreshold - minimum number of duplicate lines for high priority warnings

normalThreshold - minimum number of duplicate lines for normal priority warnings

Method Detail

getPriority

protected Severity getPriority(int lines)

Returns the priority of the warning.

Parameters:

lines - number of duplicate lines

Returns:

the priority of the warning

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

configureParser

protected abstract void configureParser(org.apache.commons.digester3.Digester digester)

Configures the Digester parser. Register all rules that are required to parse the file.

Parameters:

digester - the parser to configure

convertDuplicationsToIssues

protected abstract Report convertDuplicationsToIssues(List<T> duplications)

Converts the parsed duplications from the original format to an Report instance.

Parameters:

duplications - the parsed warnings

Returns:

the converted warnings