edu.umd.cs.findbugs
public class FindBugsMessageFormat extends Object
java.text.MessageFormat
;
however, each placeholder may have an optional "key" which specifies
how the object at that position should be formatted.
Example:
new FindBugsMessageFormat("BUG: {1} does something bad to field {2.fullField}")In this example, the method annotation at position 1 is formatted using the empty (default) key. The field annotation at position 2 is formatted using the "fullField" key, which uses the long format for the field rather than the usual "class.fieldname" format.
See Also: BugInstance
Constructor Summary | |
---|---|
FindBugsMessageFormat(String pattern)
Constructor.
|
Method Summary | |
---|---|
String | format(BugAnnotation[] args, ClassAnnotation primaryClass)
Format the message using the given array of BugAnnotations as arguments
to bind to the placeholders in the pattern string.
|
Parameters: pattern the pattern for the message
Parameters: args the BugAnnotations used as arguments primaryClass TODO
Returns: the formatted message