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
Report	parse(File file, Charset charset) Parses the specified file for issues.
abstract Report	parse(File 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(File 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

parse

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

Parses the specified file for issues.

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