edu.umd.cs.findbugs

Class TypeAnnotation

java.lang.Object

edu.umd.cs.findbugs.BugAnnotationWithSourceLines

edu.umd.cs.findbugs.TypeAnnotation

All Implemented Interfaces:

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

public class TypeAnnotation
extends BugAnnotationWithSourceLines

Bug annotation class for java types. This is of lighter weight than ClassAnnotation, and can be used for things like array types.

See Also:

ClassAnnotation, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSEIT_ROLE
static String	DEFAULT_ROLE
static String	EXPECTED_ROLE
static String	FOUND_ROLE
static 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

Constructors

Constructor and Description
TypeAnnotation(String typeDescriptor) constructor.
TypeAnnotation(String typeDescriptor, String roleDescription)
TypeAnnotation(org.apache.bcel.generic.Type objectType)
TypeAnnotation(org.apache.bcel.generic.Type objectType, String roleDescription)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(BugAnnotationVisitor visitor) Accept a BugAnnotationVisitor.
int	compareTo(BugAnnotation o)
boolean	equals(Object o)
String	format(String key, ClassAnnotation primaryClass) Format the annotation as a String.
String	getDescription() Get a description of this bug annotation.
String	getTypeDescriptor() Get the type descriptor.
String	getTypeParameters()
int	hashCode()
boolean	isSignificant() Is this annotation used to compute instance hashes or match bug instances across versions
void	setDescription(String roleDescription) Set a description of this bug annotation.
void	setTypeParameters(String typeParameters)
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

DEFAULT_ROLE

public static final String DEFAULT_ROLE

See Also:

Constant Field Values

EXPECTED_ROLE

public static final String EXPECTED_ROLE

See Also:

Constant Field Values

FOUND_ROLE

public static final String FOUND_ROLE

See Also:

Constant Field Values

CLOSEIT_ROLE

public static final String CLOSEIT_ROLE

See Also:

Constant Field Values

UNHASHABLE_ROLE

public static final String UNHASHABLE_ROLE

See Also:

Constant Field Values

Constructor Detail

TypeAnnotation

public TypeAnnotation(String typeDescriptor)

constructor.

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

Parameters:

typeDescriptor - a jvm type descriptor, such as "[I"

TypeAnnotation

public TypeAnnotation(org.apache.bcel.generic.Type objectType)

TypeAnnotation

public TypeAnnotation(org.apache.bcel.generic.Type objectType,
              String roleDescription)

TypeAnnotation

public TypeAnnotation(String typeDescriptor,
              String roleDescription)

Method Detail

getTypeDescriptor

public String getTypeDescriptor()

Get the type descriptor.

Returns:

the jvm type descriptor, such as "[I"

accept

public void accept(BugAnnotationVisitor visitor)

Description copied from interface: BugAnnotation

Accept a BugAnnotationVisitor.

Parameters:

visitor - the visitor to accept

format

public String format(String key,
            ClassAnnotation primaryClass)

Description copied from interface: BugAnnotation

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.

setDescription

public void setDescription(String roleDescription)

Description copied from interface: BugAnnotation

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

getDescription

public String getDescription()

Description copied from interface: BugAnnotation

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

setTypeParameters

public void setTypeParameters(String typeParameters)

getTypeParameters

public String getTypeParameters()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(BugAnnotation o)

toString

public String toString()

Overrides:

toString in class Object

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws IOException

Description copied from interface: XMLWriteable

Write this object to given XMLOutput.

Parameters:

xmlOutput - the XMLOutput for the document

Throws:

IOException

writeXML

public void writeXML(XMLOutput xmlOutput,
            boolean addMessages,
            boolean isPrimary)
              throws IOException

Throws:

IOException

isSignificant

public boolean isSignificant()

Description copied from interface: BugAnnotation

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

Returns:

true if significant