Trait

org.opalj.ai.domain

RecordReturnedValues

Related Doc: package domain

Permalink

trait RecordReturnedValues extends RecordReturnedValuesInfrastructure with CustomInitialization

Generic infrastructure to record the values returned by the method. (Note that the computational type of the value(s) is not recorded. It is directly determined by the signature of the method that is analyzed or can be extracted using the respective method.)

Usage

This domain can be stacked on top of other traits that handle return instructions that return some value.

Usage

A domain that mixes in this trait should only be used to analyze a single method.

Self Type
RecordReturnedValues with ValuesDomain with Configuration with ExceptionsFactory
Linear Supertypes
CustomInitialization, RecordReturnedValuesInfrastructure, ai.ReturnInstructionsDomain, AnyRef, Any
Known Subclasses
CFACallGraphDomain, ChildDefaultDomain, DefaultRecordMethodCallResults, RecordLastReturnedValues, RecordMethodCallResults
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordReturnedValues
  2. CustomInitialization
  3. RecordReturnedValuesInfrastructure
  4. ReturnInstructionsDomain
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type ReturnedValue <: AnyRef

    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
    RecordReturnedValuesInfrastructure

Abstract Value Members

  1. abstract def abruptMethodExecution(pc: PC, exceptionValue: (RecordReturnedValues.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
    ReturnInstructionsDomain
    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.

  2. abstract def joinReturnedValues(pc: PC, previouslyReturnedValue: (RecordReturnedValues.this)#ReturnedValue, value: (RecordReturnedValues.this)#DomainValue): (RecordReturnedValues.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]
    See also

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

  3. abstract def recordReturnedValue(pc: PC, value: (RecordReturnedValues.this)#DomainValue): (RecordReturnedValues.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]
    See also

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

  4. abstract def returnVoid(pc: PC): Computation[Nothing, (RecordReturnedValues.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
    ReturnInstructionsDomain

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to any2stringadd[RecordReturnedValues] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (RecordReturnedValues, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to ArrowAssoc[RecordReturnedValues] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def allReturnedValues: Map[PC, (RecordReturnedValues.this)#ReturnedValue]

    Permalink

    Returns the set of all returned values.

  7. def areturn(pc: PC, value: (RecordReturnedValues.this)#DomainValue): Computation[Nothing, (RecordReturnedValues.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
    RecordReturnedValuesInfrastructure → ReturnInstructionsDomain

  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: (RecordReturnedValues.this)#DomainValue): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    RecordReturnedValues → RecordReturnedValuesInfrastructure

  11. def dreturn(pc: PC, value: (RecordReturnedValues.this)#DomainValue): Computation[Nothing, (RecordReturnedValues.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
    RecordReturnedValuesInfrastructure → ReturnInstructionsDomain

  12. def ensuring(cond: (RecordReturnedValues) ⇒ Boolean, msg: ⇒ Any): RecordReturnedValues

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to Ensuring[RecordReturnedValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: (RecordReturnedValues) ⇒ Boolean): RecordReturnedValues

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to Ensuring[RecordReturnedValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean, msg: ⇒ Any): RecordReturnedValues

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to Ensuring[RecordReturnedValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean): RecordReturnedValues

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to Ensuring[RecordReturnedValues] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to StringFormat[RecordReturnedValues] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  20. def freturn(pc: PC, value: (RecordReturnedValues.this)#DomainValue): Computation[Nothing, (RecordReturnedValues.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
    RecordReturnedValuesInfrastructure → ReturnInstructionsDomain

  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  23. def initProperties(code: Code, cfJoins: BitSet, initialLocals: (RecordReturnedValues.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
    RecordReturnedValues → CustomInitialization

  24. def ireturn(pc: PC, value: (RecordReturnedValues.this)#DomainValue): Computation[Nothing, (RecordReturnedValues.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
    RecordReturnedValuesInfrastructure → ReturnInstructionsDomain

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  26. def lreturn(pc: PC, value: (RecordReturnedValues.this)#DomainValue): Computation[Nothing, (RecordReturnedValues.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
    RecordReturnedValuesInfrastructure → ReturnInstructionsDomain

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  32. final def wait(): Unit

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

  33. final def wait(arg0: Long, arg1: Int): Unit

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

  34. final def wait(arg0: Long): Unit

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

  35. def →[B](y: B): (RecordReturnedValues, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordReturnedValues to ArrowAssoc[RecordReturnedValues] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from CustomInitialization

Inherited from RecordReturnedValuesInfrastructure

Inherited from ai.ReturnInstructionsDomain

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from RecordReturnedValues to any2stringadd[RecordReturnedValues]

Inherited by implicit conversion StringFormat from RecordReturnedValues to StringFormat[RecordReturnedValues]

Inherited by implicit conversion Ensuring from RecordReturnedValues to Ensuring[RecordReturnedValues]

Inherited by implicit conversion ArrowAssoc from RecordReturnedValues to ArrowAssoc[RecordReturnedValues]

Ungrouped