edu.umd.cs.findbugs
Interface BugAnnotation

All Superinterfaces:

java.lang.Comparable<BugAnnotation>, XMLWriteable

All Known Implementing Classes:

ClassAnnotation, FieldAnnotation, IntAnnotation, MethodAnnotation, PackageMemberAnnotation, SourceLineAnnotation

public interface BugAnnotation
extends java.lang.Comparable<BugAnnotation>, XMLWriteable

An object providing context information about a particular BugInstance.

Author:

David Hovemeyer

See Also:

BugInstance

Method Summary

void	accept(BugAnnotationVisitor visitor) Accept a BugAnnotationVisitor.
java.lang.String	format(java.lang.String key) Format the annotation as a String.
java.lang.String	getDescription() Get a description of this bug annotation.
void	setDescription(java.lang.String description) Set a description of this bug annotation.

Methods inherited from interface java.lang.Comparable

compareTo

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

writeXML

Method Detail

accept

void accept(BugAnnotationVisitor visitor)

Accept a BugAnnotationVisitor.

Parameters:

visitor - the visitor to accept

format

java.lang.String format(java.lang.String key)

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

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.