edu.umd.cs.findbugs
Class ClassAnnotation

java.lang.Object
  edu.umd.cs.findbugs.PackageMemberAnnotation
      edu.umd.cs.findbugs.ClassAnnotation

All Implemented Interfaces:

BugAnnotation, XMLWriteable, java.lang.Comparable<BugAnnotation>

public class ClassAnnotation
extends PackageMemberAnnotation

A BugAnnotation object specifying a Java class involved in the bug.

Author:

David Hovemeyer

See Also:

BugAnnotation, BugInstance

Field Summary

private static java.lang.String	DEFAULT_ROLE
private static java.lang.String	ELEMENT_NAME

Fields inherited from class edu.umd.cs.findbugs.PackageMemberAnnotation

className, description

Constructor Summary

ClassAnnotation(java.lang.String className)
Constructor.

Method Summary

void	accept(BugAnnotationVisitor visitor) Accept a BugAnnotationVisitor.
int	compareTo(BugAnnotation o)
boolean	equals(java.lang.Object o)
protected java.lang.String	formatPackageMember(java.lang.String key) Do default and subclass-specific formatting.
int	hashCode()
void	writeXML(XMLOutput xmlOutput) Write this object to given XMLOutput.

Methods inherited from class edu.umd.cs.findbugs.PackageMemberAnnotation

format, getClassName, getDescription, getPackageName, setDescription, shorten, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ROLE

private static final java.lang.String DEFAULT_ROLE

See Also:

Constant Field Values

ELEMENT_NAME

private static final java.lang.String ELEMENT_NAME

See Also:

Constant Field Values

Constructor Detail

ClassAnnotation

public ClassAnnotation(java.lang.String className)

Constructor.

Parameters:

className - the name of the class

Method Detail

accept

public void accept(BugAnnotationVisitor visitor)

Description copied from interface: BugAnnotation

Accept a BugAnnotationVisitor.

Parameters:

visitor - the visitor to accept

formatPackageMember

protected java.lang.String formatPackageMember(java.lang.String key)

Description copied from class: PackageMemberAnnotation

Do default and subclass-specific formatting.

Specified by:

formatPackageMember in class PackageMemberAnnotation

Parameters:

key - the key specifying how to do the formatting

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(BugAnnotation o)

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws java.io.IOException

Description copied from interface: XMLWriteable

Write this object to given XMLOutput.

Parameters:

xmlOutput - the XMLOutput for the document

Throws:

java.io.IOException