edu.umd.cs.findbugs
Class I18N

java.lang.Object
  extended by edu.umd.cs.findbugs.I18N

public class I18N
extends java.lang.Object

Singleton responsible for returning localized strings for information returned to the user.

Author:
David Hovemeyer

Method Summary
 java.util.Iterator<BugPattern> bugPatternIterator()
          Get an Iterator over all registered bug patterns.
 java.lang.String getAnnotationDescription(java.lang.String key)
          Get an annotation description string.
 java.util.Collection<java.lang.String> getBugCategories()
          Get a Collection containing all known bug category keys.
 java.lang.String getBugCategoryDescription(java.lang.String category)
          Get the description of a bug category.
 java.lang.String getBugTypeDescription(java.lang.String shortBugType)
          Get a description for given "bug type".
 java.lang.String getDetailHTML(java.lang.String key)
          Get an HTML document describing the bug pattern for given key in detail.
 java.lang.String getMessage(java.lang.String key)
          Get a message string.
 java.lang.String getShortMessage(java.lang.String key)
          Get a short message string.
static I18N instance()
          Get the single object instance.
 BugPattern lookupBugPattern(java.lang.String bugType)
          Look up bug pattern.
 void registerBugCode(BugCode bugCode)
          Register a BugCode.
 void registerBugPattern(BugPattern bugPattern)
          Register a BugPattern.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

instance

public static I18N instance()
Get the single object instance.


registerBugPattern

public void registerBugPattern(BugPattern bugPattern)
Register a BugPattern.

Parameters:
bugPattern - the BugPattern

lookupBugPattern

public BugPattern lookupBugPattern(java.lang.String bugType)
Look up bug pattern.

Parameters:
bugType - the bug type for the bug pattern
Returns:
the BugPattern, or null if it can't be found

bugPatternIterator

public java.util.Iterator<BugPattern> bugPatternIterator()
Get an Iterator over all registered bug patterns.


registerBugCode

public void registerBugCode(BugCode bugCode)
Register a BugCode.

Parameters:
bugCode - the BugCode

getMessage

public java.lang.String getMessage(java.lang.String key)
Get a message string. This is a format pattern for describing an entire bug instance in a single line.

Parameters:
key - which message to retrieve

getShortMessage

public java.lang.String getShortMessage(java.lang.String key)
Get a short message string. This is a concrete string (not a format pattern) which briefly describes the type of bug, without mentioning particular a particular class/method/field.

Parameters:
key - which short message to retrieve

getDetailHTML

public java.lang.String getDetailHTML(java.lang.String key)
Get an HTML document describing the bug pattern for given key in detail.

Parameters:
key - which HTML details for retrieve

getAnnotationDescription

public java.lang.String getAnnotationDescription(java.lang.String key)
Get an annotation description string. This is a format pattern which will describe a BugAnnotation in the context of a particular bug instance. Its single format argument is the BugAnnotation.

Parameters:
key - the annotation description to retrieve

getBugTypeDescription

public java.lang.String getBugTypeDescription(java.lang.String shortBugType)
Get a description for given "bug type". FIXME: this is referred to elsewhere as the "bug code" or "bug abbrev". Should make the terminology consistent everywhere. In this case, the bug type refers to the short prefix code prepended to the long and short bug messages.

Parameters:
shortBugType - the short bug type code
Returns:
the description of that short bug type code means

getBugCategoryDescription

public java.lang.String getBugCategoryDescription(java.lang.String category)
Get the description of a bug category. Returns the category if no description can be found.

Parameters:
category - the category
Returns:
the description of the category

getBugCategories

public java.util.Collection<java.lang.String> getBugCategories()
Get a Collection containing all known bug category keys. E.g., "CORRECTNESS", "MT_CORRECTNESS", "PERFORMANCE", etc.

Returns:
Collection of bug category keys.