|
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.TypeAnnotation
public class TypeAnnotation
Bug annotation class for java types. This is of lighter weight than ClassAnnotation, and can be used for things like array types.
ClassAnnotation
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CLOSEIT_ROLE
|
static java.lang.String |
DEFAULT_ROLE
|
static java.lang.String |
EXPECTED_ROLE
|
static java.lang.String |
FOUND_ROLE
|
static java.lang.String |
UNHASHABLE_ROLE
|
Fields inherited from class edu.umd.cs.findbugs.BugAnnotationWithSourceLines |
---|
sourceFileName, sourceLines |
Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation |
---|
MESSAGE_TAG |
Constructor Summary | |
---|---|
TypeAnnotation(java.lang.String typeDescriptor)
constructor. |
|
TypeAnnotation(java.lang.String typeDescriptor,
java.lang.String roleDescription)
|
|
TypeAnnotation(org.apache.bcel.generic.Type objectType)
|
|
TypeAnnotation(org.apache.bcel.generic.Type objectType,
java.lang.String roleDescription)
|
Method Summary | |
---|---|
void |
accept(BugAnnotationVisitor visitor)
Accept a BugAnnotationVisitor. |
int |
compareTo(BugAnnotation o)
|
boolean |
equals(java.lang.Object o)
|
java.lang.String |
format(java.lang.String key,
ClassAnnotation primaryClass)
Format the annotation as a String. |
java.lang.String |
getDescription()
Get a description of this bug annotation. |
java.lang.String |
getTypeDescriptor()
Get the type descriptor. |
int |
hashCode()
|
boolean |
isSignificant()
Is this annotation used to compute instance hashes or match bug instances across versions |
void |
setDescription(java.lang.String roleDescription)
Set a description of this bug annotation. |
void |
setTypeParameters(java.lang.String typeParameters)
|
java.lang.String |
toString()
|
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.BugAnnotationWithSourceLines |
---|
clone, getSourceFileName, getSourceLines, setSourceLines, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_ROLE
public static final java.lang.String EXPECTED_ROLE
public static final java.lang.String FOUND_ROLE
public static final java.lang.String CLOSEIT_ROLE
public static final java.lang.String UNHASHABLE_ROLE
Constructor Detail |
---|
public TypeAnnotation(java.lang.String typeDescriptor)
For information on type descriptors,
see http://java.sun.com/docs/books/vmspec/2nd-edition/html/ClassFile.doc.html#14152
or http://www.murrayc.com/learning/java/java_classfileformat.shtml#TypeDescriptors
typeDescriptor
- a jvm type descriptor, such as "[I"public TypeAnnotation(org.apache.bcel.generic.Type objectType)
public TypeAnnotation(org.apache.bcel.generic.Type objectType, java.lang.String roleDescription)
public TypeAnnotation(java.lang.String typeDescriptor, java.lang.String roleDescription)
Method Detail |
---|
public java.lang.String getTypeDescriptor()
public void accept(BugAnnotationVisitor visitor)
BugAnnotation
visitor
- the visitor to acceptpublic java.lang.String format(java.lang.String key, ClassAnnotation primaryClass)
BugAnnotation
key
- how the annotation should be formattedprimaryClass
- The primary class for the bug; some bug annotation format msgs are simplified in relation to that class.public void setDescription(java.lang.String roleDescription)
BugAnnotation
public java.lang.String getDescription()
BugAnnotation
public void setTypeParameters(java.lang.String typeParameters)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int compareTo(BugAnnotation o)
public java.lang.String toString()
toString
in class java.lang.Object
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
public boolean isSignificant()
BugAnnotation
|
FindBugs™ 1.3.9 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |