Class XFactory

java.lang.Object
edu.umd.cs.findbugs.ba.XFactory
public class XFactory extends Object
Factory methods for creating XMethod objects.

  • Field Details

    • DEBUG_UNRESOLVED

      public static final boolean DEBUG_UNRESOLVED

    • reflectiveClasses

      private final Set<ClassDescriptor> reflectiveClasses

    • methods

      private final Map<MethodDescriptor, XMethod> methods

    • fields

      private final Map<FieldDescriptor, XField> fields

    • calledMethods

      private final Set<XMethod> calledMethods

    • emptyArrays

      private final Set<XField> emptyArrays

    • calledMethodSignatures

      @Deprecated private final Set<String> calledMethodSignatures
      Deprecated.
      This field is not updated by any code in the project. Will be removed in 5.x release.

    • functionsThatMightBeMistakenForProcedures

      private final Set<MethodDescriptor> functionsThatMightBeMistakenForProcedures

    • DEBUG_CIRCULARITY

      public static final boolean DEBUG_CIRCULARITY

  • Constructor Details

    • XFactory

      public XFactory()
      Constructor.

  • Method Details

    • canonicalizeAll

      public void canonicalizeAll()

    • intern

      public void intern(XClass c)

    • allFields

      public Collection<XField> allFields()

    • addCalledMethod

      public void addCalledMethod(MethodDescriptor m)

    • addEmptyArrayField

      public void addEmptyArrayField(XField f)

    • isEmptyArrayField

      public boolean isEmptyArrayField(@CheckForNull XField f)

    • isCalled

      public boolean isCalled(XMethod m)

    • getCalledMethods

      public Set<XMethod> getCalledMethods()

    • addFunctionThatMightBeMistakenForProcedures

      public void addFunctionThatMightBeMistakenForProcedures(MethodDescriptor m)

    • isFunctionshatMightBeMistakenForProcedures

      public boolean isFunctionshatMightBeMistakenForProcedures(MethodDescriptor m)

    • getReflectiveClasses

      public Set<ClassDescriptor> getReflectiveClasses()

    • isReflectiveClass

      public boolean isReflectiveClass(ClassDescriptor c)

    • addReflectiveClasses

      public boolean addReflectiveClasses(ClassDescriptor c)

    • isCalledDirectlyOrIndirectly

      public boolean isCalledDirectlyOrIndirectly(XMethod m)

    • isCalledDirectlyOrIndirectly

      private boolean isCalledDirectlyOrIndirectly(@CheckForNull ClassDescriptor clazzDescriptor, XMethod m) throws CheckedAnalysisException
      Throws:
      CheckedAnalysisException

    • nameAndSignatureIsCalled

      @Deprecated public boolean nameAndSignatureIsCalled(XMethod m)
      Deprecated.
      This method does not work as expected. Will be removed in 5.x release.

    • getDetailedSignature

      private static String getDetailedSignature(XMethod m2)

    • isInterned

      @Deprecated public boolean isInterned(XMethod m)
      Deprecated.

    • canonicalizeString

      @Deprecated public static String canonicalizeString(String s)
      Deprecated.
      See Also:

    • createXMethod

      public static XMethod createXMethod(String className, org.apache.bcel.classfile.Method method)
      Create an XMethod object from a BCEL Method.
      Parameters:
      className - the class to which the Method belongs
      method - the Method
      Returns:
      an XMethod representing the Method

    • createXMethod

      private static XMethod createXMethod(@DottedClassName String className, String methodName, String methodSig, int accessFlags)

    • createXMethod

      public static XMethod createXMethod(org.apache.bcel.classfile.JavaClass javaClass, org.apache.bcel.classfile.Method method)
      Create an XMethod object from a BCEL Method.
      Parameters:
      javaClass - the class to which the Method belongs
      method - the Method
      Returns:
      an XMethod representing the Method

    • assertDottedClassName

      public static void assertDottedClassName(@DottedClassName String className)

    • assertSlashedClassName

      public static void assertSlashedClassName(@SlashedClassName String className)

    • createXMethodUsingSlashedClassName

      public static XMethod createXMethodUsingSlashedClassName(@SlashedClassName String className, String methodName, String methodSig, boolean isStatic)
      Parameters:
      className -
      methodName -
      methodSig -
      isStatic -
      Returns:
      the created XMethod

    • createXMethod

      public static XMethod createXMethod(@DottedClassName String className, String methodName, String methodSig, boolean isStatic)
      Parameters:
      className -
      methodName -
      methodSig -
      isStatic -
      Returns:
      the created XMethod

    • createXMethod

      public static XMethod createXMethod(MethodDescriptor desc)

    • profile

      public static void profile()

    • resolveXMethod

      private XMethod resolveXMethod(MethodDescriptor originalDescriptor)

    • createXMethod

      public static XMethod createXMethod(MethodAnnotation ma)

    • createXFieldUsingSlashedClassName

      public static XField createXFieldUsingSlashedClassName(@SlashedClassName String className, String fieldName, String fieldSignature, boolean isStatic)
      Create an XField object
      Parameters:
      className -
      fieldName -
      fieldSignature -
      isStatic -
      Returns:
      the created XField

    • createXField

      public static XField createXField(@DottedClassName String className, String fieldName, String fieldSignature, boolean isStatic)
      Create an XField object
      Parameters:
      className -
      fieldName -
      fieldSignature -
      isStatic -
      Returns:
      the created XField

    • createXField

      public static XField createXField(org.apache.bcel.generic.FieldInstruction fieldInstruction, org.apache.bcel.generic.ConstantPoolGen cpg)

    • createReferencedXField

      public static XField createReferencedXField(DismantleBytecode visitor)

    • createReferencedXMethod

      public static XMethod createReferencedXMethod(DismantleBytecode visitor)

    • createXField

      public static XField createXField(FieldAnnotation f)

    • createXField

      public static XField createXField(org.apache.bcel.classfile.JavaClass javaClass, org.apache.bcel.classfile.Field field)

    • createXField

      public static XField createXField(String className, org.apache.bcel.classfile.Field field)
      Create an XField object from a BCEL Field.
      Parameters:
      className - the name of the Java class containing the field
      field - the Field within the JavaClass
      Returns:
      the created XField

    • getExactXField

      public static XField getExactXField(@SlashedClassName String className, String name, String signature, boolean isStatic)
      Get an XField object exactly matching given class, name, and signature. May return an unresolved object (if the class can't be found, or does not directly declare named field).
      Parameters:
      className - name of class containing the field
      name - name of field
      signature - field signature
      isStatic - field access flags
      Returns:
      XField exactly matching class name, field name, and field signature

    • getExactXField

      @Nonnull public static XField getExactXField(@SlashedClassName String className, org.apache.bcel.classfile.Field f)

    • getExactXField

      @Nonnull public static XField getExactXField(FieldDescriptor desc)

    • createXField

      public static XField createXField(FieldDescriptor desc)

    • resolveXField

      private XField resolveXField(FieldDescriptor originalDescriptor)

    • createXMethod

      public static XMethod createXMethod(org.apache.bcel.generic.InvokeInstruction invokeInstruction, org.apache.bcel.generic.ConstantPoolGen cpg)
      Create an XMethod object from an InvokeInstruction.
      Parameters:
      invokeInstruction - the InvokeInstruction
      cpg - ConstantPoolGen from the class containing the instruction
      Returns:
      XMethod representing the method called by the InvokeInstruction

    • createXMethod

      public static XMethod createXMethod(PreorderVisitor visitor)
      Create an XMethod object from the method currently being visited by the given PreorderVisitor.
      Parameters:
      visitor - the PreorderVisitor
      Returns:
      the XMethod representing the method currently being visited

    • createXField

      public static XField createXField(PreorderVisitor visitor)
      Create an XField object from the field currently being visited by the given PreorderVisitor.
      Parameters:
      visitor - the PreorderVisitor
      Returns:
      the XField representing the method currently being visited

    • createXMethod

      public static XMethod createXMethod(org.apache.bcel.generic.MethodGen methodGen)

    • createXMethod

      public static XMethod createXMethod(JavaClassAndMethod classAndMethod)

    • getXClass

      @CheckForNull public XClass getXClass(ClassDescriptor classDescriptor)
      Get the XClass object providing information about the class named by the given ClassDescriptor.
      Parameters:
      classDescriptor - a ClassDescriptor
      Returns:
      an XClass object providing information about the class, or null if the class cannot be found

    • compare

      public static <E extends ClassMember> int compare(E lhs, E rhs)
      Compare XMethod or XField object objects. All methods that implement XMethod or XField should delegate to this method when implementing compareTo(Object) if the right-hand object implements XField or XMethod.
      Parameters:
      lhs - an XMethod or XField
      rhs - an XMethod or XField
      Returns:
      comparison of lhs and rhs