MethodAnnotation (findbugs 3.0.1)

java.lang.Object
- edu.umd.cs.findbugs.BugAnnotationWithSourceLines
- - edu.umd.cs.findbugs.PackageMemberAnnotation
  - - edu.umd.cs.findbugs.MethodAnnotation

All Implemented Interfaces:

BugAnnotation, XMLWriteable, XMLWriteableWithMessages, Serializable, Cloneable, Comparable<BugAnnotation>
```
public class MethodAnnotation
extends PackageMemberAnnotation
```
A BugAnnotation specifying a particular method in a particular class. A MethodAnnotation may (optionally) have a SourceLineAnnotation directly embedded inside it to indicate the range of source lines where the method is defined.

Author:

David Hovemeyer

See Also:
BugAnnotation, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ROLE`
`static String`	`METHOD_ALTERNATIVE_TARGET`
`static String`	`METHOD_CALLED`
`static String`	`METHOD_COMPUTED_IN`
`static String`	`METHOD_CONSTRUCTOR`
`static String`	`METHOD_DANGEROUS_TARGET`
`static String`	`METHOD_DANGEROUS_TARGET_ACTUAL_GUARANTEED_NULL`
`static String`	`METHOD_DID_YOU_MEAN_TO_OVERRIDE`
`static String`	`METHOD_EQUALS_USED`
`static String`	`METHOD_OVERRIDDEN`
`static String`	`METHOD_RETURN_VALUE_OF`
`static String`	`METHOD_SAFE_TARGET`
`static String`	`METHOD_SUPERCLASS_CONSTRUCTOR`
`static String`	`SHOULD_CALL`

Fields inherited from class edu.umd.cs.findbugs.PackageMemberAnnotation
className, description

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
`MethodAnnotation(String className, String methodName, String methodSig, boolean isStatic)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(BugAnnotationVisitor visitor)` Accept a BugAnnotationVisitor.
`int`	`compareTo(BugAnnotation o)`
`boolean`	`equals(Object o)`
`protected String`	`formatPackageMember(String key, ClassAnnotation primaryClass)` Do default and subclass-specific formatting.
`static MethodAnnotation`	`fromCalledMethod(DismantleBytecode visitor)` Factory method to create a MethodAnnotation from a method called by the instruction the given visitor is currently visiting.
`static MethodAnnotation`	`fromCalledMethod(String className, String methodName, String methodSig, boolean isStatic)` Create a MethodAnnotation from a method that is not directly accessible.
`static MethodAnnotation`	`fromForeignMethod(String className, String methodName, String methodSig, boolean isStatic)` Factory method to create the MethodAnnotation from the classname, method name, signature, etc.
`static MethodAnnotation`	`fromForeignMethod(String className, String methodName, String methodSig, int accessFlags)` Factory method to create the MethodAnnotation from the classname, method name, signature, etc.
`static MethodAnnotation`	`fromMethodDescriptor(MethodDescriptor methodDescriptor)` Create a MethodAnnotation from a MethodDescriptor.
`static MethodAnnotation`	`fromVisitedMethod(PreorderVisitor visitor)` Factory method to create a MethodAnnotation from the method the given visitor is currently visiting.
`static MethodAnnotation`	`fromXMethod(XMethod xmethod)` Create a MethodAnnotation from an XMethod.
`String`	`getFullMethod(ClassAnnotation primaryClass)` Get the "full" method name.
`String`	`getJavaSourceMethodName()`
`String`	`getMethodName()` Get the method name.
`String`	`getMethodSignature()` Get the method type signature.
`String`	`getNameInClass(boolean shortenPackages, boolean useJVMMethodName, boolean hash)`
`String`	`getNameInClass(boolean shortenPackages, boolean useJVMMethodName, boolean hash, boolean omitMethodName)` Get the "full" method name.
`String`	`getNameInClass(ClassAnnotation primaryClass)` Get the "full" method name.
`String`	`getSignatureInClass(ClassAnnotation primaryClass)`
`int`	`hashCode()`
`boolean`	`isSignificant()` Is this annotation used to compute instance hashes or match bug instances across versions
`boolean`	`isStatic()` Return whether or not the method is static.
`String`	`stripJavaLang(String className)`
`MethodDescriptor`	`toMethodDescriptor()`
`XMethod`	`toXMethod()` Convert to an XMethod.
`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.PackageMemberAnnotation
format, getClassDescriptor, getClassName, getDescription, getPackageName, getSimpleClassName, getSlashedClassName, removePackage, removePackageName, setDescription, shorten, toString, toString

Methods inherited from class edu.umd.cs.findbugs.BugAnnotationWithSourceLines
clone, getSourceFileName, getSourceLines, setSourceLines

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
  - METHOD_DANGEROUS_TARGET_ACTUAL_GUARANTEED_NULL
```
public static final String METHOD_DANGEROUS_TARGET_ACTUAL_GUARANTEED_NULL
```
    See Also:
    Constant Field Values
  - METHOD_DANGEROUS_TARGET
```
public static final String METHOD_DANGEROUS_TARGET
```
    See Also:
    Constant Field Values
  - METHOD_RETURN_VALUE_OF
```
public static final String METHOD_RETURN_VALUE_OF
```
    See Also:
    Constant Field Values
  - METHOD_SAFE_TARGET
```
public static final String METHOD_SAFE_TARGET
```
    See Also:
    Constant Field Values
  - METHOD_EQUALS_USED
```
public static final String METHOD_EQUALS_USED
```
    See Also:
    Constant Field Values
  - METHOD_CALLED
```
public static final String METHOD_CALLED
```
    See Also:
    Constant Field Values
  - METHOD_SUPERCLASS_CONSTRUCTOR
```
public static final String METHOD_SUPERCLASS_CONSTRUCTOR
```
    See Also:
    Constant Field Values
  - METHOD_CONSTRUCTOR
```
public static final String METHOD_CONSTRUCTOR
```
    See Also:
    Constant Field Values
  - METHOD_OVERRIDDEN
```
public static final String METHOD_OVERRIDDEN
```
    See Also:
    Constant Field Values
  - METHOD_DID_YOU_MEAN_TO_OVERRIDE
```
public static final String METHOD_DID_YOU_MEAN_TO_OVERRIDE
```
    See Also:
    Constant Field Values
  - METHOD_COMPUTED_IN
```
public static final String METHOD_COMPUTED_IN
```
    See Also:
    Constant Field Values
  - METHOD_ALTERNATIVE_TARGET
```
public static final String METHOD_ALTERNATIVE_TARGET
```
    See Also:
    Constant Field Values
  - SHOULD_CALL
```
public static final String SHOULD_CALL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - MethodAnnotation
```
public MethodAnnotation(@DottedClassName
                String className,
                String methodName,
                String methodSig,
                boolean isStatic)
```
    Constructor.
    
    Parameters:
    className - the name of the class containing the method
    methodName - the name of the method
    methodSig - the Java type signature of the method
    isStatic - true if the method is static, false if not
- Method Detail
  - fromVisitedMethod
```
public static MethodAnnotation fromVisitedMethod(PreorderVisitor visitor)
```
    Factory method to create a MethodAnnotation from the method the given visitor is currently visiting.
    
    Parameters:
    visitor - the BetterVisitor currently visiting the method
  - fromCalledMethod
```
public static MethodAnnotation fromCalledMethod(DismantleBytecode visitor)
```
    Factory method to create a MethodAnnotation from a method called by the instruction the given visitor is currently visiting.
    
    Parameters:
    visitor - the visitor
    
    Returns:
    the MethodAnnotation representing the called method
  - fromForeignMethod
```
public static MethodAnnotation fromForeignMethod(@SlashedClassName
                                 String className,
                                 String methodName,
                                 String methodSig,
                                 int accessFlags)
```
    Factory method to create the MethodAnnotation from the classname, method name, signature, etc. The method tries to look up source line information for the method.
    
    Parameters:
    className - name of the class containing the method
    methodName - name of the method
    methodSig - signature of the method
    accessFlags - the access flags of the method
    
    Returns:
    the MethodAnnotation
  - fromForeignMethod
```
public static MethodAnnotation fromForeignMethod(String className,
                                 String methodName,
                                 String methodSig,
                                 boolean isStatic)
```
    Factory method to create the MethodAnnotation from the classname, method name, signature, etc. The method tries to look up source line information for the method.
    
    Parameters:
    className - name of the class containing the method
    methodName - name of the method
    methodSig - signature of the method
    isStatic - true if the method is static, false otherwise
    
    Returns:
    the MethodAnnotation
  - fromCalledMethod
```
public static MethodAnnotation fromCalledMethod(String className,
                                String methodName,
                                String methodSig,
                                boolean isStatic)
```
    Create a MethodAnnotation from a method that is not directly accessible. We will use the repository to try to find its class in order to populate the information as fully as possible.
    
    Parameters:
    className - class containing called method
    methodName - name of called method
    methodSig - signature of called method
    isStatic - true if called method is static
    
    Returns:
    the MethodAnnotation for the called method
  - fromXMethod
```
public static MethodAnnotation fromXMethod(XMethod xmethod)
```
    Create a MethodAnnotation from an XMethod.
    
    Parameters:
    xmethod - the XMethod
    
    Returns:
    the MethodAnnotation
  - fromMethodDescriptor
```
public static MethodAnnotation fromMethodDescriptor(MethodDescriptor methodDescriptor)
```
    Create a MethodAnnotation from a MethodDescriptor.
    
    Parameters:
    methodDescriptor - the MethodDescriptor
    
    Returns:
    the MethodAnnotation
  - getMethodName
```
public String getMethodName()
```
    Get the method name.
  - getJavaSourceMethodName
```
public String getJavaSourceMethodName()
```
  - getMethodSignature
```
public String getMethodSignature()
```
    Get the method type signature.
  - isStatic
```
public boolean isStatic()
```
    Return whether or not the method is static.
    
    Returns:
    true if the method is static, false otherwise
  - toXMethod
```
public XMethod toXMethod()
```
    Convert to an XMethod.
    
    Returns:
    an XMethod specifying the same method as this MethodAnnotation
  - toMethodDescriptor
```
public MethodDescriptor toMethodDescriptor()
```
  - accept
```
public void accept(BugAnnotationVisitor visitor)
```
    Description copied from interface: BugAnnotation
    
    Accept a BugAnnotationVisitor.
    
    Parameters:
    visitor - the visitor to accept
  - formatPackageMember
```
protected String formatPackageMember(String key,
                         ClassAnnotation primaryClass)
```
    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
    primaryClass - TODO
  - getNameInClass
```
public String getNameInClass(ClassAnnotation primaryClass)
```
    Get the "full" method name. This is a format which looks sort of like a method signature that would appear in Java source code.
  - getSignatureInClass
```
public String getSignatureInClass(ClassAnnotation primaryClass)
```
  - getNameInClass
```
public String getNameInClass(boolean shortenPackages,
                    boolean useJVMMethodName,
                    boolean hash)
```
  - getNameInClass
```
public String getNameInClass(boolean shortenPackages,
                    boolean useJVMMethodName,
                    boolean hash,
                    boolean omitMethodName)
```
    Get the "full" method name. This is a format which looks sort of like a method signature that would appear in Java source code. note: If shortenPackeges==true, this will return the same value as getNameInClass(), except that method caches the result and this one does not. Calling this one may be slow.
    
    Parameters:
    shortenPackages - whether to shorten package names if they are in java or in the same package as this method.
  - getFullMethod
```
public String getFullMethod(ClassAnnotation primaryClass)
```
    Get the "full" method name. This is a format which looks sort of like a method signature that would appear in Java source code.
  - stripJavaLang
```
public String stripJavaLang(@DottedClassName
                   String className)
```
  - 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)
```
  - 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
    
    Specified by:
    
    isSignificant in interface BugAnnotation
    
    Overrides:
    
    isSignificant in class PackageMemberAnnotation
    
    Returns:
    true if significant

Class MethodAnnotation

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ROLE

METHOD_DANGEROUS_TARGET_ACTUAL_GUARANTEED_NULL

METHOD_DANGEROUS_TARGET

METHOD_RETURN_VALUE_OF

METHOD_SAFE_TARGET

METHOD_EQUALS_USED

METHOD_CALLED

METHOD_SUPERCLASS_CONSTRUCTOR

METHOD_CONSTRUCTOR

METHOD_OVERRIDDEN

METHOD_DID_YOU_MEAN_TO_OVERRIDE

METHOD_COMPUTED_IN

METHOD_ALTERNATIVE_TARGET

SHOULD_CALL

Constructor Detail

MethodAnnotation

Method Detail

fromVisitedMethod

fromCalledMethod

fromForeignMethod

fromForeignMethod

fromCalledMethod

fromXMethod

fromMethodDescriptor

getMethodName

getJavaSourceMethodName

getMethodSignature

isStatic

toXMethod

toMethodDescriptor

accept

formatPackageMember

getNameInClass

getSignatureInClass

getNameInClass

getNameInClass

getFullMethod

stripJavaLang

hashCode

equals

compareTo

writeXML

writeXML

isSignificant