edu.hm.hafner.analysis

Class IssueParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractParser, FindBugsParser

public abstract class IssueParser
extends Object
implements Serializable

Parses a file and returns the issues reported in this file.

Author:

Ullrich Hafner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IssueParser()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Path file, Charset charset) Returns whether this parser accepts the specified file as valid input.
protected boolean	isXmlFile(Path file) Returns whether the specified file is an XML file.
Report	parse(Path file, Charset charset) Parses the specified file for issues.
abstract Report	parse(Path file, Charset charset, Function<String,String> preProcessor) Parses the specified file for issues.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueParser

public IssueParser()

Method Detail

parse

public abstract Report parse(Path file,
                             Charset charset,
                             Function<String,String> preProcessor)
                      throws ParsingException,
                             ParsingCanceledException

Parses the specified file for issues.

Parameters:

file - the file to parse

charset - the encoding to use when reading files

preProcessor - pre processes each input line before handing it to the actual parser

Returns:

the issues

Throws:

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

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

accepts

public boolean accepts(Path file,
                       Charset charset)

Returns whether this parser accepts the specified file as valid input. Parsers may reject a file if it is in the wrong format and will produce exceptions otherwise.

Parameters:

file - the file to parse

charset - the encoding to use when reading files

Returns:

true if this parser accepts this file as valid input, or false if the file could not be parsed by this parser

parse

public Report parse(Path file,
                    Charset charset)
             throws ParsingException,
                    ParsingCanceledException

Parses the specified file for issues. Parses a file without pre-processing the lines.

Parameters:

file - the file to parse

charset - the encoding to use when reading files

Returns:

the issues

Throws:

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

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

isXmlFile

protected boolean isXmlFile(Path file)

Returns whether the specified file is an XML file. This method just checks if the first 10 lines contain the XML tag rather than parsing the whole document.

Parameters:

file - the file to check

Returns:

true if the file is an XML file, false otherwise