edu.umd.cs.findbugs

Interface BugAnnotation

public interface BugAnnotation extends Comparable<BugAnnotation>, XMLWriteableWithMessages, Serializable, Cloneable

An object providing context information about a particular BugInstance.

Author: David Hovemeyer

Field Summary
static String	MESSAGE_TAG XML tag for a formatted text message describing the annotation.

Method Summary
void	accept(BugAnnotationVisitor visitor) Accept a BugAnnotationVisitor.
Object	clone()
String	format(String key, ClassAnnotation primaryClass) Format the annotation as a String.
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(String description) Set a description of this bug annotation.

Field Detail

MESSAGE_TAG

public static final String MESSAGE_TAG

XML tag for a formatted text message describing the annotation.

Method Detail

accept

public void accept(BugAnnotationVisitor visitor)

Accept a BugAnnotationVisitor.

Parameters: visitor the visitor to accept

clone

public Object clone()

format

public String format(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 TODO

getDescription

public String getDescription()

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

isSignificant

public boolean isSignificant()

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

Returns: true if significant

setDescription

public void setDescription(String description)

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