Trait

org.opalj.ai.domain

DefaultRecordMethodCallResults

Related Doc: package domain

Permalink

trait DefaultRecordMethodCallResults extends RecordMethodCallResults with RecordLastReturnedValues with RecordAllThrownExceptions

Records the results of the evaluation of the current method such that the results can directly be adapted to the calling context and can be used by the caller to continue the abstract interpretation of the calling method.

Self Type
DefaultRecordMethodCallResults with Domain with TheClassHierarchy
Source
DefaultRecordMethodCallResults.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultRecordMethodCallResults
  2. RecordAllThrownExceptions
  3. RecordLastReturnedValues
  4. RecordMethodCallResults
  5. RecordThrownExceptions
  6. RecordReturnedValues
  7. CustomInitialization
  8. RecordReturnedValuesInfrastructure
  9. ReturnInstructionsDomain
  10. MethodCallResults
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type ReturnedValue = (DefaultRecordMethodCallResults.this)#DomainValue

    Permalink

    This type determines in which way the returned values are recorded.

    This type determines in which way the returned values are recorded.

    For example, if it is sufficient to just record the last value that was returned by a specific return instruction, then the type could be DomainValue and the implementation of joinReturnedValues(...) would just return the last given value. Furthermore, returnedValue would be the identity function.

    However, if you have a (more) precise domain you may want to collect all returned values. In this case the type of ReturnedValue could be Set[DomainValue].

    Definition Classes
    RecordLastReturnedValuesRecordReturnedValuesInfrastructure
  2. type ThrownException = Set[(DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    This type determines in which way thrown exceptions are recorded.

    This type determines in which way thrown exceptions are recorded.

    For example, if you want to collect all thrown exceptions, then the type of ThrownException could be Set[ThrownException].

    Definition Classes
    RecordAllThrownExceptionsRecordThrownExceptions
    See also

    The implementation of org.opalj.ai.domain.RecordLastReturnedValues. It follows the same pattern.

    The implementation of org.opalj.ai.domain.RecordAllThrownExceptions.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def abruptMethodExecution(pc: PC, exception: (DefaultRecordMethodCallResults.this)#ExceptionValue): Unit

    Permalink

    Called by the abstract interpreter when an exception is thrown that is not (guaranteed to be) handled within the same method.

    Called by the abstract interpreter when an exception is thrown that is not (guaranteed to be) handled within the same method.

    Definition Classes
    RecordThrownExceptionsReturnInstructionsDomain
    Note

    If the original exception value is null (/*E.g.*/throw null;), then the exception that is actually thrown is a new NullPointerException. This situation is, however, completely handled by OPAL and the exception value is hence never null.

  5. def allReturnedValues: Map[PC, (DefaultRecordMethodCallResults.this)#ReturnedValue]

    Permalink

    Returns the set of all returned values.

    Returns the set of all returned values.

    Definition Classes
    RecordReturnedValues
  6. def allThrownExceptions: Map[PC, (DefaultRecordMethodCallResults.this)#ThrownException]

    Permalink
    Definition Classes
    RecordThrownExceptions
  7. def areturn(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): Computation[Nothing, (DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    The given value, which is a value with computational type reference, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type reference, is returned by the return instruction with the given pc.

    Definition Classes
    RecordReturnedValuesInfrastructureReturnInstructionsDomain
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def doRecordReturnedValue(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    RecordReturnedValuesRecordReturnedValuesInfrastructure
  11. def dreturn(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): Computation[Nothing, (DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    The given value, which is a value with computational type double, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type double, is returned by the return instruction with the given pc.

    Definition Classes
    RecordReturnedValuesInfrastructureReturnInstructionsDomain
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def freturn(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): Computation[Nothing, (DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    The given value, which is a value with computational type float, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type float, is returned by the return instruction with the given pc.

    Definition Classes
    RecordReturnedValuesInfrastructureReturnInstructionsDomain
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. def initProperties(code: Code, cfJoins: BitSet, initialLocals: (DefaultRecordMethodCallResults.this)#Locals): Unit

    Permalink

    Override this method to perform custom initialization steps.

    Override this method to perform custom initialization steps.

    Always use abstract override and call the super method; it is recommended to complete the initialization of this domain before calling the super method.

    Definition Classes
    RecordReturnedValuesCustomInitialization
  19. def ireturn(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): Computation[Nothing, (DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    The given value, which is a value with computational type integer, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type integer, is returned by the return instruction with the given pc.

    Definition Classes
    RecordReturnedValuesInfrastructureReturnInstructionsDomain
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def joinReturnedValues(pc: PC, previouslyReturnedValue: (DefaultRecordMethodCallResults.this)#ReturnedValue, value: (DefaultRecordMethodCallResults.this)#DomainValue): (DefaultRecordMethodCallResults.this)#ReturnedValue

    Permalink

    Joins the previously returned value and the newly given value.

    Joins the previously returned value and the newly given value. Both values are returned by the same return instruction (same pc).

    pc

    The program counter of the return instruction. The returned values are automatically associated with the pc of the instruction. Hence, it is not strictly required to store it in the ReturnedValue.

    Attributes
    protected[this]
    Definition Classes
    RecordLastReturnedValuesRecordReturnedValues
    See also

    For details study the documentation of the abstract type ReturnedValue and study the subclass(es) of RecordReturnedValues.

  22. def joinThrownExceptions(pc: PC, previouslyThrownException: (DefaultRecordMethodCallResults.this)#ThrownException, value: (DefaultRecordMethodCallResults.this)#ExceptionValue): (DefaultRecordMethodCallResults.this)#ThrownException

    Permalink

    Joins the previously thrown exception(s) and the newly thrown exception.

    Joins the previously thrown exception(s) and the newly thrown exception. Both exceptions are thrown by the same instruction (same pc).

    Attributes
    protected[this]
    Definition Classes
    RecordAllThrownExceptionsRecordThrownExceptions
    Note

    The instruction might be an athrow instruction or some other instruction that throws an exception.

    See also

    For details study the documentation of the abstract type ThrownException and study the subclass(es) of RecordThrownExceptions.

  23. def lreturn(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): Computation[Nothing, (DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    The given value, which is a value with computational type long, is returned by the return instruction with the given pc.

    The given value, which is a value with computational type long, is returned by the return instruction with the given pc.

    Definition Classes
    RecordReturnedValuesInfrastructureReturnInstructionsDomain
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. def recordReturnedValue(pc: PC, value: (DefaultRecordMethodCallResults.this)#DomainValue): (DefaultRecordMethodCallResults.this)#ReturnedValue

    Permalink

    Wraps the given value into a ReturnedValue.

    Wraps the given value into a ReturnedValue.

    pc

    The program counter of the return instruction. The returned values are automatically associated with the pc of the instruction. Hence, it is not strictly required to store it in the ReturnedValue.

    Attributes
    protected[this]
    Definition Classes
    RecordLastReturnedValuesRecordReturnedValues
    See also

    For details study the documentation of the abstract type ReturnedValue and study the subclass(es) of RecordReturnedValues.

  28. def recordThrownException(pc: PC, value: (DefaultRecordMethodCallResults.this)#ExceptionValue): (DefaultRecordMethodCallResults.this)#ThrownException

    Permalink

    Wraps the given value into a ThrownException.

    Wraps the given value into a ThrownException.

    pc

    The program counter of the instruction that throws the exception. It is automatically stored in the map that associates instructions with the exceptions that are thrown.

    Attributes
    protected[this]
    Definition Classes
    RecordAllThrownExceptionsRecordThrownExceptions
    See also

    For details study the documentation of the abstract type ThrownException and study the subclass(es) of RecordThrownExceptions.

  29. def returnVoid(pc: PC): Computation[Nothing, (DefaultRecordMethodCallResults.this)#ExceptionValue]

    Permalink

    Called when a return instruction with the given pc is reached.

    Called when a return instruction with the given pc is reached. In other words, when the method returns normally.

    Definition Classes
    RecordMethodCallResultsReturnInstructionsDomain
  30. def returnedNormally: Boolean

    Permalink

    true if the method returned due to a ("void"|a|i|l|f|d)return instruction.

    true if the method returned due to a ("void"|a|i|l|f|d)return instruction.

    Definition Classes
    RecordMethodCallResultsMethodCallResults
    Note

    This method may only be called after the abstract interpretation of a method has completed.

  31. def returnedValue(target: TargetDomain, callerPC: PC): Option[(target)#DomainValue]

    Permalink

    Adapts and returns the returned value.

    Adapts and returns the returned value.

    Definition Classes
    RecordMethodCallResultsMethodCallResults
    Note

    This method may only be called after the abstract interpretation of a method has completed.

    ,

    This method is only defined if the method returned normally. In this case None is returned if the method's return type is void; Some(DomainValue) is returned otherwise.

  32. def returnedValueRemapped(callerDomain: TargetDomain, callerPC: PC)(originalOperands: (callerDomain)#Operands, passedParameters: (DefaultRecordMethodCallResults.this)#Locals): Option[(callerDomain)#DomainValue]

    Permalink

    Maps the returned value back to the original operand value if possible.

    Maps the returned value back to the original operand value if possible.

    Definition Classes
    RecordMethodCallResultsMethodCallResults
    Note

    This method may only be called after the abstract interpretation of a method has completed.

    ,

    This method is only defined if the method returned normally. In this case None is returned if the method's return type is void; Some(DomainValue) is returned otherwise.

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def thrownExceptions(target: TargetDomain, callerPC: PC): (target)#ExceptionValues

    Permalink

    Adapts and returns the exceptions that are thrown by the called method.

    Adapts and returns the exceptions that are thrown by the called method.

    In general, for each type of exception there should be at most one ExceptionValue.

    Definition Classes
    RecordMethodCallResultsMethodCallResults
    Note

    This method may only be called after the abstract interpretation of a method has completed.

  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RecordAllThrownExceptions

Inherited from RecordLastReturnedValues

Inherited from RecordMethodCallResults

Inherited from RecordThrownExceptions

Inherited from RecordReturnedValues

Inherited from CustomInitialization

Inherited from MethodCallResults

Inherited from AnyRef

Inherited from Any

Ungrouped