|
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
edu.umd.cs.findbugs.ClassAnnotation
public class ClassAnnotation
A BugAnnotation object specifying a Java class involved in the bug.
BugAnnotation
,
BugInstance
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ANNOTATION_ROLE
|
static java.lang.String |
IMPLEMENTED_INTERFACE_ROLE
|
static java.lang.String |
INTERFACE_ROLE
|
static java.lang.String |
SUBCLASS_ROLE
|
static java.lang.String |
SUPERCLASS_ROLE
|
Fields inherited from class edu.umd.cs.findbugs.PackageMemberAnnotation |
---|
className, 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 | |
---|---|
ClassAnnotation(java.lang.String className)
Constructor. |
Method Summary | |
---|---|
void |
accept(BugAnnotationVisitor visitor)
Accept a BugAnnotationVisitor. |
int |
compareTo(BugAnnotation o)
|
boolean |
contains(ClassAnnotation other)
|
boolean |
equals(java.lang.Object o)
|
protected java.lang.String |
formatPackageMember(java.lang.String key,
ClassAnnotation primaryClass)
Do default and subclass-specific formatting. |
static ClassAnnotation |
fromClassDescriptor(ClassDescriptor classDescriptor)
Factory method to create a ClassAnnotation from a ClassDescriptor. |
SourceLineAnnotation |
getSourceLines()
Get the SourceLineAnnotation describing the source lines where the method is defined. |
static SourceLineAnnotation |
getSourceLinesForClass(java.lang.String className,
java.lang.String sourceFileName)
|
ClassAnnotation |
getTopLevelClass()
|
int |
hashCode()
|
boolean |
isSignificant()
Is this annotation used to compute instance hashes or match bug instances across versions |
void |
writeXML(XMLOutput xmlOutput)
Write this object to given XMLOutput. |
void |
writeXML(XMLOutput xmlOutput,
boolean addMessages,
boolean isPrimary)
|
Methods inherited from class edu.umd.cs.findbugs.PackageMemberAnnotation |
---|
format, getClassDescriptor, getClassName, getDescription, getPackageName, removePackage, removePackageName, setDescription, shorten, toString, toString |
Methods inherited from class edu.umd.cs.findbugs.BugAnnotationWithSourceLines |
---|
clone, getSourceFileName, setSourceLines |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SUBCLASS_ROLE
public static final java.lang.String SUPERCLASS_ROLE
public static final java.lang.String IMPLEMENTED_INTERFACE_ROLE
public static final java.lang.String INTERFACE_ROLE
public static final java.lang.String ANNOTATION_ROLE
Constructor Detail |
---|
public ClassAnnotation(java.lang.String className)
className
- the name of the classMethod Detail |
---|
public boolean isSignificant()
BugAnnotation
isSignificant
in interface BugAnnotation
isSignificant
in class PackageMemberAnnotation
public static ClassAnnotation fromClassDescriptor(ClassDescriptor classDescriptor)
classDescriptor
- the ClassDescriptor
public void accept(BugAnnotationVisitor visitor)
BugAnnotation
visitor
- the visitor to acceptprotected java.lang.String formatPackageMember(java.lang.String key, ClassAnnotation primaryClass)
PackageMemberAnnotation
formatPackageMember
in class PackageMemberAnnotation
key
- the key specifying how to do the formattingprimaryClass
- TODOpublic int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public boolean contains(ClassAnnotation other)
public ClassAnnotation getTopLevelClass()
public int compareTo(BugAnnotation o)
public SourceLineAnnotation getSourceLines()
BugAnnotationWithSourceLines
getSourceLines
in class BugAnnotationWithSourceLines
public static SourceLineAnnotation getSourceLinesForClass(@DottedClassName java.lang.String className, java.lang.String sourceFileName)
public void writeXML(XMLOutput xmlOutput) throws java.io.IOException
XMLWriteable
xmlOutput
- the XMLOutput for the document
java.io.IOException
public void writeXML(XMLOutput xmlOutput, boolean addMessages, boolean isPrimary) throws java.io.IOException
java.io.IOException
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |