Package edu.umd.cs.findbugs

Interface BugAnnotation

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable<BugAnnotation>, java.io.Serializable, XMLWriteable, XMLWriteableWithMessages

All Known Implementing Classes:

BugAnnotationWithSourceLines, ClassAnnotation, FieldAnnotation, IntAnnotation, LocalVariableAnnotation, MethodAnnotation, PackageMemberAnnotation, SourceLineAnnotation, StringAnnotation, TypeAnnotation

public interface BugAnnotation
extends java.lang.Comparable<BugAnnotation>, XMLWriteableWithMessages, java.io.Serializable, java.lang.Cloneable

An object providing context information about a particular BugInstance.

A custom bug annotation can implement a static method called 'fromXML(String qName, Attributes attributes)', and ensure its ELEMENT_NAME equals to its CLASSNAME. Then, the handler will find the annotation class and invoke this method to deserialize annotation when the report xml is loaded.

Author:

David Hovemeyer

See Also:

BugInstance

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MESSAGE_TAG	XML tag for a formatted text message describing the annotation.

Method Summary

Modifier and Type	Method	Description
void	accept(BugAnnotationVisitor visitor)	Accept a BugAnnotationVisitor.
java.lang.Object	clone()
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.
boolean	isSignificant()	Is this annotation used to compute instance hashes or match bug instances across versions
void	setDescription(java.lang.String description)	Set a description of this bug annotation.
java.lang.String	toString(ClassAnnotation primaryClass)

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface edu.umd.cs.findbugs.xml.XMLWriteable

writeXML

Methods inherited from interface edu.umd.cs.findbugs.XMLWriteableWithMessages

writeXML

Field Detail

MESSAGE_TAG

static final java.lang.String MESSAGE_TAG

XML tag for a formatted text message describing the annotation.

See Also:

Constant Field Values

Method Detail

clone

java.lang.Object clone()

accept

void accept(BugAnnotationVisitor visitor)

Accept a BugAnnotationVisitor.

Parameters:

visitor - the visitor to accept

format

java.lang.String format(java.lang.String key,
                        ClassAnnotation primaryClass)

Format the annotation as a String. The given key specifies additional information about how the annotation should be formatted. If the key is empty, then the "default" format will be used.

Parameters:

key - how the annotation should be formatted

primaryClass - The primary class for the bug; some bug annotation format msgs are simplified in relation to that class.

getDescription

java.lang.String getDescription()

Get a description of this bug annotation. The description is a key for the FindBugsAnnotationDescriptions resource bundle.

setDescription

void setDescription(java.lang.String description)

Set a description of this bug annotation. The description is a key for the FindBugsAnnotationDescriptions resource bundle.

isSignificant

boolean isSignificant()

Is this annotation used to compute instance hashes or match bug instances across versions

Returns:

true if significant

toString

java.lang.String toString(ClassAnnotation primaryClass)