|
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.BugAnnotationWithSourceLines
edu.umd.cs.findbugs.PackageMemberAnnotation
public abstract class PackageMemberAnnotation
Abstract base class for BugAnnotations describing constructs which are contained in a Java package. Specifically, this includes classes, methods, and fields.
BugAnnotation
,
Serialized FormField Summary | |
---|---|
protected java.lang.String |
className
|
protected java.lang.String |
description
|
Fields inherited from class edu.umd.cs.findbugs.BugAnnotationWithSourceLines |
---|
sourceFileName, sourceLines |
Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation |
---|
MESSAGE_TAG |
Constructor Summary | |
---|---|
protected |
PackageMemberAnnotation(java.lang.String className,
java.lang.String description)
Constructor. |
Method Summary | |
---|---|
java.lang.String |
format(java.lang.String key,
ClassAnnotation primaryClass)
Format the annotation. |
protected abstract java.lang.String |
formatPackageMember(java.lang.String key,
ClassAnnotation primaryClass)
Do default and subclass-specific formatting. |
ClassDescriptor |
getClassDescriptor()
Get the class name. |
java.lang.String |
getClassName()
Get the class name. |
java.lang.String |
getDescription()
Get a description of this bug annotation. |
java.lang.String |
getPackageName()
Get the package name. |
boolean |
isSignificant()
Is this annotation used to compute instance hashes or match bug instances across versions |
protected static java.lang.String |
removePackage(java.lang.String typeName)
|
protected static java.lang.String |
removePackageName(java.lang.String typeName)
Shorten a type name by removing the package name |
void |
setDescription(java.lang.String description)
Set a description of this bug annotation. |
protected static java.lang.String |
shorten(java.lang.String pkgName,
java.lang.String typeName)
Shorten a type name of remove extraneous components. |
java.lang.String |
toString()
All PackageMemberAnnotation object share a common toString() implementation. |
java.lang.String |
toString(ClassAnnotation primaryClass)
|
Methods inherited from class edu.umd.cs.findbugs.BugAnnotationWithSourceLines |
---|
clone, getSourceFileName, getSourceLines, setSourceLines |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface edu.umd.cs.findbugs.BugAnnotation |
---|
accept |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Methods inherited from interface edu.umd.cs.findbugs.XMLWriteableWithMessages |
---|
writeXML |
Methods inherited from interface edu.umd.cs.findbugs.xml.XMLWriteable |
---|
writeXML |
Field Detail |
---|
@DottedClassName protected final java.lang.String className
protected java.lang.String description
Constructor Detail |
---|
protected PackageMemberAnnotation(@DottedClassName java.lang.String className, java.lang.String description)
className
- name of the classMethod Detail |
---|
@DottedClassName public final java.lang.String getClassName()
public final ClassDescriptor getClassDescriptor()
public final java.lang.String getPackageName()
public final java.lang.String format(java.lang.String key, ClassAnnotation primaryClass)
key
- the keyprimaryClass
- The primary class for the bug; some bug annotation format msgs are simplified in relation to that class.
public void setDescription(java.lang.String description)
BugAnnotation
public java.lang.String getDescription()
BugAnnotation
protected static java.lang.String shorten(java.lang.String pkgName, java.lang.String typeName)
java.lang
package.
protected static java.lang.String removePackage(java.lang.String typeName)
protected static java.lang.String removePackageName(java.lang.String typeName)
protected abstract java.lang.String formatPackageMember(java.lang.String key, ClassAnnotation primaryClass)
key
- the key specifying how to do the formattingprimaryClass
- TODOpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(ClassAnnotation primaryClass)
toString
in interface BugAnnotation
toString
in class BugAnnotationWithSourceLines
public boolean isSignificant()
BugAnnotation
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |