|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.umd.cs.findbugs.I18N
public class I18N
Singleton responsible for returning localized strings for information returned to the user.
Field Summary | |
---|---|
private java.util.ResourceBundle |
annotationDescriptionBundle
|
private java.util.ResourceBundle |
bugCategoryDescriptionBundle
|
private java.util.HashMap<java.lang.String,BugCode> |
bugCodeMap
|
private java.util.HashMap<java.lang.String,BugPattern> |
bugPatternMap
|
private static I18N |
theInstance
|
Constructor Summary | |
---|---|
private |
I18N()
|
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 |
Field Detail |
---|
private final java.util.ResourceBundle annotationDescriptionBundle
private final java.util.ResourceBundle bugCategoryDescriptionBundle
private final java.util.HashMap<java.lang.String,BugPattern> bugPatternMap
private final java.util.HashMap<java.lang.String,BugCode> bugCodeMap
private static final I18N theInstance
Constructor Detail |
---|
private I18N()
Method Detail |
---|
public static I18N instance()
public void registerBugPattern(BugPattern bugPattern)
bugPattern
- the BugPatternpublic BugPattern lookupBugPattern(java.lang.String bugType)
bugType
- the bug type for the bug pattern
public java.util.Iterator<BugPattern> bugPatternIterator()
public void registerBugCode(BugCode bugCode)
bugCode
- the BugCodepublic java.lang.String getMessage(java.lang.String key)
key
- which message to retrievepublic java.lang.String getShortMessage(java.lang.String key)
key
- which short message to retrievepublic java.lang.String getDetailHTML(java.lang.String key)
key
- which HTML details for retrievepublic java.lang.String getAnnotationDescription(java.lang.String key)
key
- the annotation description to retrievepublic java.lang.String getBugTypeDescription(java.lang.String shortBugType)
shortBugType
- the short bug type code
public java.lang.String getBugCategoryDescription(java.lang.String category)
category
- the category
public java.util.Collection<java.lang.String> getBugCategories()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |