edu.umd.cs.findbugs
public abstract class PackageMemberAnnotation extends Object implements BugAnnotation
See Also: BugAnnotation
Field Summary | |
---|---|
protected String | className |
protected String | description |
protected String | sourceFileName |
protected SourceLineAnnotation | sourceLines |
Constructor Summary | |
---|---|
protected | PackageMemberAnnotation(String className, String description)
Constructor.
|
Method Summary | |
---|---|
String | format(String key, ClassAnnotation primaryClass)
Format the annotation.
|
protected abstract String | formatPackageMember(String key, ClassAnnotation primaryClass)
Do default and subclass-specific formatting.
|
String | getClassName()
Get the class name. |
String | getDescription() |
String | getPackageName()
Get the package name. |
String | getSourceFileName()
Get the source file name. |
SourceLineAnnotation | getSourceLines()
Get the SourceLineAnnotation describing the source lines
where the method is defined.
|
boolean | isSignificant() |
protected static String | removePackageName(String typeName)
Shorten a type name by removing the package name |
void | setDescription(String description) |
void | setSourceLines(SourceLineAnnotation sourceLines)
Set a SourceLineAnnotation describing the source lines
where the package element is defined. |
protected static String | shorten(String pkgName, String typeName)
Shorten a type name of remove extraneous components.
|
Parameters: className name of the class
Parameters: key the key
Returns: the formatted annotation
Parameters: key the key specifying how to do the formatting primaryClass TODO
Returns: the SourceLineAnnotation, or null if there is no source information for this package element
java.lang
package.