edu.umd.cs.findbugs

Class TypeAnnotation

public class TypeAnnotation extends Object implements BugAnnotation

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

Field Summary
static String	CLOSEIT_ROLE
static String	DEFAULT_ROLE
static String	EXPECTED_ROLE
static String	FOUND_ROLE
static String	UNHASHABLE_ROLE

Constructor Summary
	TypeAnnotation(String typeDescriptor) constructor.
	TypeAnnotation(String typeDescriptor, String roleDescription)

Method Summary
void	accept(BugAnnotationVisitor visitor)
int	compareTo(BugAnnotation o)
String	format(String key, ClassAnnotation primaryClass)
String	getDescription()
String	getTypeDescriptor() Get the type descriptor.
boolean	isSignificant()
void	setDescription(String roleDescription)
void	writeXML(XMLOutput xmlOutput)
void	writeXML(XMLOutput xmlOutput, boolean addMessages)

Field Detail

EXPECTED_ROLE

public static final String EXPECTED_ROLE

UNHASHABLE_ROLE

public static final String UNHASHABLE_ROLE

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"