Module edu.hm.hafner.analysis.model

Package edu.hm.hafner.analysis.registry

Class FindBugsDescriptor

java.lang.Object

edu.hm.hafner.analysis.registry.ParserDescriptor

edu.hm.hafner.analysis.registry.FindBugsDescriptor

public class FindBugsDescriptor
extends ParserDescriptor

A descriptor for the FindBugs parser.

Author:

Lorenz Munsch

Nested Class Summary

Nested classes/interfaces inherited from class edu.hm.hafner.analysis.registry.ParserDescriptor

ParserDescriptor.Option

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIORITY_OPTION_KEY	Key to define minimum number of duplicate lines for high priority warnings.

Method Summary

Modifier and Type	Method	Description
IssueParser	createParser(ParserDescriptor.Option... options)	Creates a new IssueParser instance.
String	getDescription(Issue issue)	Returns a detailed description of the specified issue.
String	getPattern()	Returns the default filename pattern for this tool.

Methods inherited from class edu.hm.hafner.analysis.registry.ParserDescriptor

getHelp, getIconUrl, getId, getName, getUrl, hasHelp, hasUrl

Methods inherited from class java.lang.Object

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

Field Details

PRIORITY_OPTION_KEY

public static final String PRIORITY_OPTION_KEY

Key to define minimum number of duplicate lines for high priority warnings.

See Also:

• Constant Field Values

Method Details

createParser

public IssueParser createParser(ParserDescriptor.Option... options)

Description copied from class: ParserDescriptor

Creates a new IssueParser instance.

Specified by:

createParser in class ParserDescriptor

Parameters:

options - options to configure the parser - may customize the new parser instance (if supported by the selected tool)

Returns:

the parser

getPattern

public String getPattern()

Description copied from class: ParserDescriptor

Returns the default filename pattern for this tool. Override if your parser typically works on a specific file. This pattern will be interpreted as an ANT pattern or glob, resp.

Overrides:

getPattern in class ParserDescriptor

Returns:

the default pattern

getDescription

public String getDescription(Issue issue)

Description copied from class: ParserDescriptor

Returns a detailed description of the specified issue. If there is no additional description is available, then an empty String is returned.

Overrides:

getDescription in class ParserDescriptor

Parameters:

issue - the issue to get the description for

Returns:

the description