hudson.plugins.findbugs

Class FindBugsMessages

java.lang.Object

hudson.plugins.findbugs.FindBugsMessages

public final class FindBugsMessages
extends Object

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

Author:

Ulli Hafner

Method Summary

Modifier and Type	Method and Description
static FindBugsMessages	getInstance() Returns the singleton instance.
String	getMessage(String name, Locale locale) Returns a HTML description for the specified bug.
String	getShortMessage(String name, Locale locale) Returns a short description for the specified bug.
List<Pattern>	parse(InputStream file) Parses the FindBugs pattern description.
int	size() Returns the size of this messages cache.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FindBugsMessages getInstance()

Returns the singleton instance.

Returns:

the singleton instance

parse

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

Parses the FindBugs pattern description.

Parameters:

file - XML file with the messages

Returns:

a list of parsed patterns

Throws:

SAXException - if we can't parse the file

IOException - if we can't read the file

getMessage

public String getMessage(String name,
                         Locale locale)

Returns a HTML description for the specified bug.

Parameters:

name - name of the bug

locale - the locale of the user

Returns:

a HTML description

getShortMessage

public String getShortMessage(String name,
                              Locale locale)

Returns a short description for the specified bug.

Parameters:

name - name of the bug

locale - the locale of the user

Returns:

a HTML description for the specified bug.

size

public int size()

Returns the size of this messages cache.

Returns:

the number of stored messages (English locale)