Package edu.umd.cs.findbugs
Class I18N
java.lang.Object
edu.umd.cs.findbugs.I18N
Singleton responsible for returning localized strings for information
returned to the user.
- Author:
- David Hovemeyer
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Locale
static final Comparator
<String> a Comparator to compare user designation keys -
Method Summary
Modifier and TypeMethodDescriptionGet an annotation description string.getBugCategoryDescription
(String category) Get the description of a bug category.getBugTypeDescription
(String shortBugType) Get a description for given "bug type".getDetailHTML
(String key) Get an HTML document describing the bug pattern for given key in detail.getMessage
(String key) Deprecated.getShortMessage
(String key) Get a short message string.getUserDesignation
(String key) Get the localized user designation string.getUserDesignationKey
(int index) Get a List containing all known user designation keys keys.getUserDesignationKeys
(boolean sort) Get a List containing all known user designation keys keys.static I18N
instance()
Get the single object instance.
-
Field Details
-
designationKeyComparator
a Comparator to compare user designation keys -
defaultLocale
-
-
Method Details
-
instance
Get the single object instance. -
getMessage
Deprecated.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
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
-
getShortMessageWithoutCode
-
getDetailHTML
Get an HTML document describing the bug pattern for given key in detail.- Parameters:
key
- which HTML details for retrieve
-
getAnnotationDescription
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
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
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
-
getUserDesignation
Get the localized user designation string. Returns the key if no user designation can be found.- Parameters:
key
- the user designation key- Returns:
- the localized designation string
-
getUserDesignationKeys
Get a List containing all known user designation keys keys. E.g., "MOSTLY_HARMLESS", "MUST_FIX", "NOT_A_BUG", etc.- Returns:
- List of user designation keys
-
getUserDesignationKeys
Get a List containing all known user designation keys keys. E.g., "MOSTLY_HARMLESS", "MUST_FIX", "NOT_A_BUG", etc. Ifsort == true
then it will attempt to sort the List as appropriate to show the user.- Returns:
- List of user designation keys
-
getUserDesignationKey
-