Modul edu.hm.hafner.analysis.model

Package edu.hm.hafner.analysis.parser.findbugs

Klasse FindBugsMessages

java.lang.Object

edu.hm.hafner.analysis.parser.findbugs.FindBugsMessages

public final class FindBugsMessages
extends Object

Parses the FindBugs pattern descriptions and provides access to these HTML messages.

Autor:

Ullrich Hafner

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	FindBugsMessages.Pattern	Bug pattern describing a bug type.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
FindBugsMessages()	Loads the available rules into a map.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getMessage(String name)	Returns a HTML description for the specified bug.
String	getShortMessage(String name)	Returns a short description for the specified bug.
List<FindBugsMessages.Pattern>	parse(InputStream file)	Parses the FindBugs pattern description.
int	size()	Returns the size of this messages cache.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

FindBugsMessages

public FindBugsMessages()

Loads the available rules into a map.

Methodendetails

parse

public List<FindBugsMessages.Pattern> parse(InputStream file)
                                     throws IOException,
SAXException

Parses the FindBugs pattern description.

Parameter:

file - XML file with the messages

Gibt zurück:

a list of parsed patterns

Löst aus:

SAXException - if we can't parse the file

IOException - if we can't read the file

getMessage

public String getMessage(String name)

Returns a HTML description for the specified bug.

Parameter:

name - name of the bug

Gibt zurück:

a HTML description

getShortMessage

public String getShortMessage(String name)

Returns a short description for the specified bug.

Parameter:

name - name of the bug

Gibt zurück:

a HTML description for the specified bug.

size

public int size()

Returns the size of this messages cache.

Gibt zurück:

the number of stored messages (English locale)