edu.hm.hafner.analysis.parser.violations

Class AbstractViolationAdapter

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.AbstractParser

edu.hm.hafner.analysis.parser.violations.AbstractViolationAdapter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AndroidLintParserAdapter, CodeNarcAdapter, CppCheckAdapter, DocFxAdapter, ErrorProneAdapter, Flake8Adapter, JsHintAdapter, KlocWorkAdapter, MyPyAdapter, PitAdapter, PyDocStyleAdapter, ResharperInspectCodeAdapter, XmlLintAdapter, YamlLintAdapter, ZptLintAdapter

public abstract class AbstractViolationAdapter
extends AbstractParser

Adapter for ViolationsParser instances. Converts the results of a ViolationsParser into a static analysis Report.

Author:

Ullrich Hafner

See Also:

Serialized Form

Field Summary

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

DEPRECATION, PROPRIETARY_API

Constructor Summary

Constructors

Constructor and Description
AbstractViolationAdapter()

Method Summary

Modifier and Type	Method and Description
protected Severity	convertSeverity(se.bjurr.violations.lib.model.SEVERITY severity, se.bjurr.violations.lib.model.Violation violation) Computes the Severity from the specified SEVERITY.
protected abstract se.bjurr.violations.lib.parsers.ViolationsParser	createParser() Creates a new parser instance.
protected void	extractAdditionalProperties(IssueBuilder builder, se.bjurr.violations.lib.model.Violation violation) Sub-classes may add additional IssueBuilder properties based on the content of the specified Violation.
protected boolean	isValid(se.bjurr.violations.lib.model.Violation violation) Returns whether this violation is valid and should be converted to an Issue.
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

parse

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractViolationAdapter

public AbstractViolationAdapter()

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

createParser

protected abstract se.bjurr.violations.lib.parsers.ViolationsParser createParser()

Creates a new parser instance.

Returns:

the ViolationsParser instance

isValid

protected boolean isValid(se.bjurr.violations.lib.model.Violation violation)

Returns whether this violation is valid and should be converted to an Issue. Return false if the specified violation is a false positive or should not be counted.

Parameters:

violation - the violation to check

Returns:

true if the violation is valid, false otherwise

extractAdditionalProperties

protected void extractAdditionalProperties(IssueBuilder builder,
                                           se.bjurr.violations.lib.model.Violation violation)

Sub-classes may add additional IssueBuilder properties based on the content of the specified Violation. This default implementation is empty.

Parameters:

builder - the issue builder to change

violation - the violation instance

convertSeverity

protected Severity convertSeverity(se.bjurr.violations.lib.model.SEVERITY severity,
                                   se.bjurr.violations.lib.model.Violation violation)

Computes the Severity from the specified SEVERITY. Sub-classes may override and use any of the properties of the provided violation.

Parameters:

severity - the severity

violation - the violation instance

Returns:

the Severity