|
FindBugs™ 1.3.9 | |||||||||
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 | |
---|---|
static java.util.Locale |
defaultLocale
|
static java.util.Comparator<java.lang.String> |
designationKeyComparator
a Comparator to compare user designation keys |
Method Summary | |
---|---|
java.util.Iterator<BugCode> |
bugCodeIterator()
Get an Iterator over all registered bug codes. |
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. |
BugCategory |
getBugCategory(java.lang.String category)
Get the BugCategory object for a category key. |
java.lang.String |
getBugCategoryDescription(java.lang.String category)
Get the description of a bug category. |
java.util.Collection<BugCategory> |
getBugCategoryObjects()
|
BugCode |
getBugCode(java.lang.String shortBugType)
Get a description for given "bug type". |
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)
Deprecated. |
java.lang.String |
getShortMessage(java.lang.String key)
Get a short message string. |
java.lang.String |
getShortMessageWithoutCode(java.lang.String key)
|
java.lang.String |
getUserDesignation(java.lang.String key)
Get the localized user designation string. |
java.lang.String |
getUserDesignationKey(int index)
|
java.util.List<java.lang.String> |
getUserDesignationKeys()
Get a List containing all known user designation keys keys. |
java.util.List<java.lang.String> |
getUserDesignationKeys(boolean sort)
Get a List containing all known user designation keys keys. |
static I18N |
instance()
Get the single object instance. |
BugPattern |
lookupBugPattern(java.lang.String bugType)
Look up bug pattern. |
boolean |
registerBugCategory(java.lang.String category,
BugCategory bc)
Set the metadata for a bug category. |
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 |
---|
public static final java.util.Comparator<java.lang.String> designationKeyComparator
public static final java.util.Locale defaultLocale
Method Detail |
---|
public static I18N instance()
public void registerBugPattern(BugPattern bugPattern)
bugPattern
- the BugPattern@CheckForNull public BugPattern lookupBugPattern(java.lang.String bugType)
bugType
- the bug type for the bug pattern
public java.util.Iterator<BugPattern> bugPatternIterator()
public java.util.Iterator<BugCode> bugCodeIterator()
public void registerBugCode(BugCode bugCode)
bugCode
- the BugCode@Deprecated @NonNull public java.lang.String getMessage(java.lang.String key)
key
- which message to retrieve@NonNull public java.lang.String getShortMessage(java.lang.String key)
key
- which short message to retrieve@NonNull public java.lang.String getShortMessageWithoutCode(java.lang.String key)
@NonNull public 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 BugCode getBugCode(java.lang.String shortBugType)
shortBugType
- the short bug type code
@NonNull public java.lang.String getBugTypeDescription(java.lang.String shortBugType)
shortBugType
- the short bug type code
public boolean registerBugCategory(java.lang.String category, BugCategory bc)
category
- the category keybc
- the BugCategory object holding the metadata for the category
public BugCategory getBugCategory(java.lang.String category)
category
- the category key
public java.lang.String getBugCategoryDescription(java.lang.String category)
category
- the category
public java.util.Collection<java.lang.String> getBugCategories()
public java.util.Collection<BugCategory> getBugCategoryObjects()
public java.lang.String getUserDesignation(java.lang.String key)
key
- the user designation key
public java.util.List<java.lang.String> getUserDesignationKeys()
public java.util.List<java.lang.String> getUserDesignationKeys(boolean sort)
sort == true
then it will attempt to sort
the List as appropriate to show the user.
public java.lang.String getUserDesignationKey(int index)
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |