edu.hm.hafner.analysis.parser

Class EclipseParser

java.lang.Object

edu.hm.hafner.analysis.IssueParser

edu.hm.hafner.analysis.AbstractParser

edu.hm.hafner.analysis.RegexpParser

edu.hm.hafner.analysis.RegexpDocumentParser

edu.hm.hafner.analysis.parser.EclipseParser

All Implemented Interfaces:

Serializable

public class EclipseParser
extends RegexpDocumentParser

A parser for Eclipse compiler warnings.

Author:

Ullrich Hafner, Jason Faust

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANT_ECLIPSE_WARNING_PATTERN Pattern for eclipse warnings.

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

ANT_TASK, FALSE_POSITIVE

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

DEPRECATION, PROPRIETARY_API

Constructor Summary

Constructors

Constructor and Description
EclipseParser() Creates a new instance of EclipseParser.

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 Issue	createIssue(Matcher matcher, IssueBuilder builder) Creates a new issue for the specified pattern.

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

parse

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

findIssues

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

getFileName, guessCategory, guessCategoryIfEmpty, parse, parse, parseInt

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

isXmlFile, parse

Methods inherited from class java.lang.Object

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

Field Detail

ANT_ECLIPSE_WARNING_PATTERN

public static final String ANT_ECLIPSE_WARNING_PATTERN

Pattern for eclipse warnings.

See Also:

Constant Field Values

Constructor Detail

EclipseParser

public EclipseParser()

Creates a new instance of EclipseParser.

Method Detail

accepts

public boolean accepts(Path file,
                       Charset charset)

Description copied from class: IssueParser

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.

Overrides:

accepts in class IssueParser

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

createIssue

protected Issue createIssue(Matcher matcher,
                            IssueBuilder builder)

Description copied from class: RegexpParser

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 you can return the constant RegexpParser.FALSE_POSITIVE to ignore this warning.

Specified by:

createIssue in class RegexpParser

Parameters:

matcher - the regular expression matcher

builder - the issue builder to use

Returns:

a new annotation for the specified pattern