Package edu.umd.cs.findbugs.ba.obl

Class ObligationFactory

java.lang.Object
edu.umd.cs.findbugs.ba.obl.ObligationFactory
public class ObligationFactory extends Object
Factory for Obligation and ObligationSet objects to be used in an instance of ObligationAnalysis.

  • Constructor Details

    • ObligationFactory

      public ObligationFactory()

  • Method Details

    • getMaxObligationTypes

      public int getMaxObligationTypes()

    • signatureInvolvesObligations

      public boolean signatureInvolvesObligations(String sig)

    • isObligationType

      public boolean isObligationType(ClassDescriptor classDescriptor)
      Determine whether class named by given ClassDescriptor is an Obligation type.
      Parameters:
      classDescriptor - a class
      Returns:
      true if the class is an Obligation type, false otherwise

    • obligationIterator

      public Iterator<Obligation> obligationIterator()
      Get an Iterator over known Obligation types.
      Returns:
      Iterator over known Obligation types

    • getObligationByType

      @CheckForNull public Obligation getObligationByType(org.apache.bcel.generic.ObjectType type) throws ClassNotFoundException
      Look up an Obligation by type. This returns the first Obligation that is a supertype of the type given (meaning that the given type could be an instance of the returned Obligation).
      Parameters:
      type - a type
      Returns:
      an Obligation that is a supertype of the given type, or null if there is no such Obligation
      Throws:
      ClassNotFoundException

    • getObligationByType

      @CheckForNull public Obligation getObligationByType(ClassDescriptor classDescriptor)
      Look up an Obligation by type. This returns the first Obligation that is a supertype of the type given (meaning that the given type could be an instance of the returned Obligation).
      Parameters:
      classDescriptor - a ClassDescriptor naming a class type
      Returns:
      an Obligation that is a supertype of the given type, or null if there is no such Obligation

    • getParameterObligationTypes

      public Obligation[] getParameterObligationTypes(XMethod xmethod)
      Get array of Obligation types corresponding to the parameters of the given method.
      Parameters:
      xmethod - a method
      Returns:
      array of Obligation types for each of the method's parameters; a null element means the corresponding parameter is not an Obligation type

    • addObligation

      public Obligation addObligation(@DottedClassName String className)

    • getObligationById

      public Obligation getObligationById(int id)

    • getObligationByName

      public Obligation getObligationByName(@DottedClassName String className)

    • createObligationSet

      public ObligationSet createObligationSet()