FindBugs™ 1.3.4

edu.umd.cs.findbugs
Class LocalVariableAnnotation

java.lang.Object
  extended by edu.umd.cs.findbugs.LocalVariableAnnotation
All Implemented Interfaces:
BugAnnotation, XMLWriteable, XMLWriteableWithMessages, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BugAnnotation>

public class LocalVariableAnnotation
extends java.lang.Object
implements BugAnnotation

Bug annotation class for local variable names

Author:
William Pugh
See Also:
BugAnnotation, Serialized Form

Field Summary
 
Fields inherited from interface edu.umd.cs.findbugs.BugAnnotation
MESSAGE_TAG
 
Constructor Summary
LocalVariableAnnotation(java.lang.String name, int register, int pc)
          Constructor.
 
Method Summary
 void accept(BugAnnotationVisitor visitor)
          Accept a BugAnnotationVisitor.
 java.lang.Object clone()
           
 int compareTo(BugAnnotation o)
           
 boolean equals(java.lang.Object o)
           
 java.lang.String format(java.lang.String key, ClassAnnotation primaryClass)
          Format the annotation as a String.
 java.lang.String getDescription()
          Get a description of this bug annotation.
static LocalVariableAnnotation getLocalVariableAnnotation(org.apache.bcel.classfile.Method method, int local, int position1, int position2)
           
static LocalVariableAnnotation getLocalVariableAnnotation(org.apache.bcel.classfile.Method method, Location location, org.apache.bcel.generic.IndexedInstruction ins)
           
 java.lang.String getName()
           
static LocalVariableAnnotation getParameterLocalVariableAnnotation(org.apache.bcel.classfile.Method method, int local)
          Get a local variable annotation describing a parameter.
 int getPC()
           
 int getRegister()
           
 int hashCode()
           
 boolean isSignificant()
          Is this annotation used to compute instance hashes or match bug instances across versions
 void setDescription(java.lang.String description)
          Set a description of this bug annotation.
 java.lang.String toString()
           
 void writeXML(XMLOutput xmlOutput)
          Write this object to given XMLOutput.
 void writeXML(XMLOutput xmlOutput, boolean addMessages, boolean isPrimary)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LocalVariableAnnotation

public LocalVariableAnnotation(java.lang.String name,
                               int register,
                               int pc)
Constructor.

Parameters:
name - the name of the local variable
register - the local variable index
pc - the bytecode offset of the instruction that mentions this local variable
Method Detail

getLocalVariableAnnotation

public static LocalVariableAnnotation getLocalVariableAnnotation(org.apache.bcel.classfile.Method method,
                                                                 Location location,
                                                                 org.apache.bcel.generic.IndexedInstruction ins)

getLocalVariableAnnotation

public static LocalVariableAnnotation getLocalVariableAnnotation(org.apache.bcel.classfile.Method method,
                                                                 int local,
                                                                 int position1,
                                                                 int position2)

getParameterLocalVariableAnnotation

public static LocalVariableAnnotation getParameterLocalVariableAnnotation(org.apache.bcel.classfile.Method method,
                                                                          int local)
Get a local variable annotation describing a parameter.

Parameters:
method - a Method
local - the local variable containing the parameter
Returns:
LocalVariableAnnotation describing the parameter

clone

public java.lang.Object clone()
Specified by:
clone in interface BugAnnotation
Overrides:
clone in class java.lang.Object

accept

public void accept(BugAnnotationVisitor visitor)
Description copied from interface: BugAnnotation
Accept a BugAnnotationVisitor.

Specified by:
accept in interface BugAnnotation
Parameters:
visitor - the visitor to accept

format

public java.lang.String format(java.lang.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.

Specified by:
format in interface BugAnnotation
Parameters:
key - how the annotation should be formatted
primaryClass - TODO

setDescription

public void setDescription(java.lang.String description)
Description copied from interface: BugAnnotation
Set a description of this bug annotation. The description is a key for the FindBugsAnnotationDescriptions resource bundle.

Specified by:
setDescription in interface BugAnnotation

getDescription

public java.lang.String getDescription()
Description copied from interface: BugAnnotation
Get a description of this bug annotation. The description is a key for the FindBugsAnnotationDescriptions resource bundle.

Specified by:
getDescription in interface BugAnnotation

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)
Specified by:
compareTo in interface java.lang.Comparable<BugAnnotation>

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

writeXML

public void writeXML(XMLOutput xmlOutput)
              throws java.io.IOException
Description copied from interface: XMLWriteable
Write this object to given XMLOutput.

Specified by:
writeXML in interface XMLWriteable
Parameters:
xmlOutput - the XMLOutput for the document
Throws:
java.io.IOException

writeXML

public void writeXML(XMLOutput xmlOutput,
                     boolean addMessages,
                     boolean isPrimary)
              throws java.io.IOException
Specified by:
writeXML in interface XMLWriteableWithMessages
Throws:
java.io.IOException

getName

public java.lang.String getName()
Returns:
name of local variable

getPC

public int getPC()

getRegister

public int getRegister()

isSignificant

public boolean isSignificant()
Description copied from interface: BugAnnotation
Is this annotation used to compute instance hashes or match bug instances across versions

Specified by:
isSignificant in interface BugAnnotation
Returns:
true if significant

FindBugs™ 1.3.4

FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.