Package edu.umd.cs.findbugs

Class BugAnnotationWithSourceLines

java.lang.Object

edu.umd.cs.findbugs.BugAnnotationWithSourceLines

All Implemented Interfaces:

BugAnnotation, XMLWriteable, XMLWriteableWithMessages, Serializable, Cloneable, Comparable<BugAnnotation>

Direct Known Subclasses:

PackageMemberAnnotation, TypeAnnotation

public abstract class BugAnnotationWithSourceLines
extends Object
implements BugAnnotation

Author:

pugh

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	sourceFileName
protected SourceLineAnnotation	sourceLines

Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation

MESSAGE_TAG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BugAnnotationWithSourceLines()

Method Summary

Modifier and Type	Method	Description
Object	clone()
final String	getSourceFileName()	Get the source file name.
SourceLineAnnotation	getSourceLines()	Get the SourceLineAnnotation describing the source lines where the method is defined.
void	setSourceLines(SourceLineAnnotation sourceLines)	Set a SourceLineAnnotation describing the source lines where the package element is defined.
String	toString(ClassAnnotation primaryClass)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

accept, format, getDescription, isSignificant, setDescription

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 Details

sourceFileName

protected String sourceFileName

sourceLines

protected SourceLineAnnotation sourceLines

Constructor Details

BugAnnotationWithSourceLines

protected BugAnnotationWithSourceLines()

Method Details

clone

public Object clone()

Specified by:

clone in interface BugAnnotation

Overrides:

clone in class Object

getSourceFileName

public final String getSourceFileName()

Get the source file name.

setSourceLines

public void setSourceLines(SourceLineAnnotation sourceLines)

Set a SourceLineAnnotation describing the source lines where the package element is defined.

getSourceLines

public SourceLineAnnotation getSourceLines()

Get the SourceLineAnnotation describing the source lines where the method is defined.

Returns:

the SourceLineAnnotation, or null if there is no source information for this package element

toString

public String toString(ClassAnnotation primaryClass)

Specified by:

toString in interface BugAnnotation