Trait

org.opalj.ai.domain.l0

DefaultReferenceValuesBinding

Related Doc: package l0

Permalink

trait DefaultReferenceValuesBinding extends DefaultTypeLevelReferenceValues with DefaultExceptionsFactory

Default implementation for handling reference values.

Self Type
DefaultReferenceValuesBinding with IntegerValuesDomain with TypedValuesFactory with Configuration with TheClassHierarchy
Source
DefaultReferenceValuesBinding.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultReferenceValuesBinding
  2. DefaultExceptionsFactory
  3. DefaultTypeLevelReferenceValues
  4. TypeLevelReferenceValues
  5. AsJavaObject
  6. GeneralizedArrayHandling
  7. ReferenceValuesDomain
  8. ReferenceValuesFactory
  9. ExceptionsFactory
  10. DefaultDomainValueBinding
  11. ValuesDomain
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AReferenceValue = (DefaultReferenceValuesBinding.this)#ReferenceValue

    Permalink
  2. trait ArrayAbstraction extends AnyRef

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  3. type ArrayLoadResult = Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValues]

    Permalink

    Computation that returns the value stored in an array at a given index or an exception.

    Computation that returns the value stored in an array at a given index or an exception. The exceptions that may be thrown are: NullPointerException and ArrayIndexOutOfBoundsException.

    Definition Classes
    ReferenceValuesDomain
  4. type ArrayStoreResult = Computation[Nothing, (DefaultReferenceValuesBinding.this)#ExceptionValues]

    Permalink

    Computation that succeeds (updates the value stored in the array at the given index) or that throws an exception.

    Computation that succeeds (updates the value stored in the array at the given index) or that throws an exception. The exceptions that may be thrown are: NullPointerException, ArrayIndexOutOfBoundsException and ArrayStoreException.

    Definition Classes
    ReferenceValuesDomain
  5. class ArrayValue extends (DefaultTypeLevelReferenceValues.this)#ArrayValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ArrayType]

    Permalink

    Attributes
    protected[this]
    Definition Classes
    DefaultTypeLevelReferenceValues
  6. type DomainArrayValue = (DefaultReferenceValuesBinding.this)#ArrayValue

    Permalink
  7. final type DomainIllegalValue = (DefaultReferenceValuesBinding.this)#IllegalValue

    Permalink

    Abstracts over the concrete type of IllegalValue.

    Abstracts over the concrete type of IllegalValue.

    This type needs to be refined whenever the class IllegalValue is refined or the type DomainValue is refined.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  8. type DomainNullValue = (DefaultReferenceValuesBinding.this)#NullValue

    Permalink
  9. type DomainObjectValue = (DefaultReferenceValuesBinding.this)#ObjectValue

    Permalink
  10. type DomainReferenceValue = (DefaultReferenceValuesBinding.this)#ReferenceValue

    Permalink
  11. final type DomainReturnAddressValue = (DefaultReferenceValuesBinding.this)#ReturnAddressValue

    Permalink

    Abstracts over the concrete type of ReturnAddressValue.

    Abstracts over the concrete type of ReturnAddressValue. Needs to be fixed by some sub-trait/sub-class. In the simplest case (i.e., when neither the Value trait nor the ReturnAddressValue trait was refined) it is sufficient to write:

    type DomainReturnAddressValue = ReturnAddressValue
    Definition Classes
    DefaultDomainValueBindingValuesDomain
  12. final type DomainReturnAddressValues = (DefaultReferenceValuesBinding.this)#ReturnAddressValues

    Permalink
  13. final type DomainTypedValue[+T <: Type] = (DefaultReferenceValuesBinding.this)#TypedValue[T]

    Permalink
  14. final type DomainValue = (DefaultReferenceValuesBinding.this)#Value

    Permalink

    Abstracts over the concrete type of Value.

    Abstracts over the concrete type of Value. Needs to be refined by traits that inherit from Domain and which extend Domain's Value trait.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  15. type ExceptionValue = (DefaultReferenceValuesBinding.this)#DomainReferenceValue

    Permalink

    A simple type alias of the type DomainValue; used to facilitate comprehension.

    A simple type alias of the type DomainValue; used to facilitate comprehension.

    Definition Classes
    ValuesDomain
  16. type ExceptionValues = Iterable[(DefaultReferenceValuesBinding.this)#ExceptionValue]

    Permalink

    A type alias for Iterables of ExceptionValues; used to facilitate comprehension.

    A type alias for Iterables of ExceptionValues; used to facilitate comprehension.

    Definition Classes
    ValuesDomain
  17. class IllegalValue extends Value

    Permalink

    Represents a value that has no well defined state/type.

    Represents a value that has no well defined state/type. Such values are the result of a join of two incompatible values and are generally only found in registers (in the locals) and then identify a value that is dead.

    Attributes
    protected
    Definition Classes
    ValuesDomain
    See also

    org.opalj.ai.Domain.Value for further details.

  18. type Locals = collection.mutable.Locals[(DefaultReferenceValuesBinding.this)#DomainValue]

    Permalink

    An instruction's current register values/locals are represented using an array.

    An instruction's current register values/locals are represented using an array.

    Definition Classes
    ValuesDomain
  19. type LocalsArray = Array[(DefaultReferenceValuesBinding.this)#Locals]

    Permalink
    Definition Classes
    ValuesDomain
  20. class MObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue

    Permalink

    Attributes
    protected
    Definition Classes
    DefaultTypeLevelReferenceValues
  21. class NullValue extends (DefaultTypeLevelReferenceValues.this)#NullValue

    Permalink
    Attributes
    protected[this]
    Definition Classes
    DefaultTypeLevelReferenceValues
  22. trait ObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue

    Permalink
    Attributes
    protected
    Definition Classes
    DefaultTypeLevelReferenceValues
  23. type Operands = Chain[(DefaultReferenceValuesBinding.this)#DomainValue]

    Permalink

    An instruction's operands are represented using a list where the first element of the list represents the top level operand stack value.

    An instruction's operands are represented using a list where the first element of the list represents the top level operand stack value.

    Definition Classes
    ValuesDomain
  24. type OperandsArray = Array[(DefaultReferenceValuesBinding.this)#Operands]

    Permalink
    Definition Classes
    ValuesDomain
  25. trait RETValue extends Value

    Permalink
    Definition Classes
    ValuesDomain
  26. trait ReferenceValue extends (TypeLevelReferenceValues.this)#ReferenceValue with (TypeLevelReferenceValues.this)#ArrayAbstraction

    Permalink

    Abstracts over all values with computational type reference.

    Abstracts over all values with computational type reference. I.e., abstracts over class and array values and also the null value.

    Definition Classes
    TypeLevelReferenceValues
  27. class ReturnAddressValue extends RETValue

    Permalink

    Stores a single return address (i.e., a program counter/index into the code array).

    Stores a single return address (i.e., a program counter/index into the code array).

    Definition Classes
    ValuesDomain
    Note

    Though the framework completely handles all aspects related to return address values, it is nevertheless necessary that this class inherits from Value as return addresses are stored on the stack/in the registers. However, if the Value trait should be refined, all additional methods may – from the point-of-view of OPAL-AI - just throw an OperationNotSupportedException as these additional methods will never be called by OPAL-AI.

  28. class ReturnAddressValues extends RETValue

    Permalink

    A collection of (not furhter stored) return address values.

    A collection of (not furhter stored) return address values. Primarily used when we join the executions of subroutines.

    Definition Classes
    ValuesDomain
  29. class SObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ObjectType]

    Permalink
    Attributes
    protected
    Definition Classes
    DefaultTypeLevelReferenceValues
  30. trait SReferenceValue[T <: ReferenceType] extends AnyRef

    Permalink

    A reference value with a single (upper) type (bound).

    A reference value with a single (upper) type (bound).

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  31. trait TypedValue[+T <: Type] extends Value with KnownType

    Permalink
    Definition Classes
    ValuesDomain
  32. trait Value extends AnyRef

    Permalink

    Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.

    Abstracts over a concrete operand stack value or a value stored in one of the local variables/registers.

    Use Of Value/Dependencies On Value

    In general, subclasses and users of a Domain should not have/declare a direct dependency on Value. Instead they should use DomainValue as otherwise extensibility of a Domain may be hampered or even be impossible. The only exceptions are, of course, classes that directly inherit from this class.

    Refining Value

    If you directly extend/refine this trait (i.e., in a subclass of the Domain trait you write something like trait Value extends super.Value), make sure that you also extend all classes/traits that inherit from this type (this may require a deep mixin composition and that you refine the type DomainType accordingly). However, OPAL was designed such that extending this class should – in general – not be necessary. It may also be easier to encode the desired semantics – as far as possible – as part of the domain.

    Implementing Value

    Standard inheritance from this trait is always supported and is the primary mechanism to model an abstract domain's lattice w.r.t. some special type of value. In general, the implementation should try to avoid creating new instances of values unless strictly required to model the domain's semantics. This will greatly improve the overall performance as this framework heavily uses reference-based equality checks to speed up the evaluation.

    Definition Classes
    ValuesDomain
    Note

    OPAL does not rely on any special equality semantics w.r.t. values and never directly or indirectly calls a Value's equals or eq method. Hence, a domain can encode equality such that it best fits its need. However, some of the provided domains rely on the following semantics for equals: Two domain values have to be equal (==) iff they represent the same information. This includes additional information, such as, the value of the origin. E.g., a value (AnIntegerValue) that represents an arbitrary Integer value has to return true if the domain value with which it is compared also represents an arbitrary Integer value (AnIntegerValue). However, it may still be necessary to use multiple objects to represent an arbitrary integer value if, e.g., constraints should be attached to specific values. For example, after a comparison of an integer value with a predefined value (e.g., AnIntegerValue < 4) it is possible to constrain the respective value on the subsequent paths (< 4 on one path and >= 4 on the other path). To make that possible, it is however necessary to distinguish the AnIntegervalue from some other AnIntegerValue to avoid constraining unrelated values.

    public void foo(int a,int b) {
        if(a < 4) {
            z = a - 2 // here a is constrained (< 4), b and z are unconstrained
        }
        else {
            z = a + 2 // here a is constrained (>= 4), b and z are unconstrained
        }
    }

    In general, equals is only defined for values belonging to the same domain. If values need to be compared across domains, they need to be adapted to a target domain first.

Abstract Value Members

  1. abstract def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Permalink

    Tries to determine if the type referred to as subtype is a subtype of the specified reference type supertype.

    Tries to determine if the type referred to as subtype is a subtype of the specified reference type supertype. If the class hierarchy is not complete the answer may be Unknown.

    Definition Classes
    ReferenceValuesDomain

Concrete 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. final def ArithmeticException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a ArithmeticException and that has the given origin.

    Creates a non-null object that represent a ArithmeticException and that has the given origin. If the ArithmeticException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  5. final def ArrayIndexOutOfBoundsException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a ArrayIndexOutOfBoundsException and that has the given origin.

    Creates a non-null object that represent a ArrayIndexOutOfBoundsException and that has the given origin. If the ArrayIndexOutOfBoundsException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  6. final def ArrayStoreException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a ArrayStoreException and that has the given origin.

    Creates a non-null object that represent a ArrayStoreException and that has the given origin. If the ArrayStoreException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  7. def ArrayValue(origin: ValueOrigin, arrayType: ArrayType): (DefaultReferenceValuesBinding.this)#DomainArrayValue

    Permalink

    Creates a new DomainValue that represents an array value with unknown values and where the specified type may also just be an upper type bound (unless the component type is a primitive type or an array of primitives.)

    Creates a new DomainValue that represents an array value with unknown values and where the specified type may also just be an upper type bound (unless the component type is a primitive type or an array of primitives.)

    Typical Usage

    This factory method is (typically) used to create a domain value that represents an array if we know nothing specific about the array. E.g., if you want to analyze a method that takes an array as a parameter.

    Summary

    The properties of the value are:

    • Type: Upper Bound (unless the elementType is a base type)
    • Null: Unknown
    • Size: Unknown
    • Content: Unknown
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValues
    Note

    Java's arrays are co-variant. I.e., Object[] a = new Serializable[100]; is valid.

  8. object ArrayValue

    Permalink

    Enables matching of DomainValues that are array values.

    Enables matching of DomainValues that are array values.

    Definition Classes
    DefaultTypeLevelReferenceValues
  9. final def ClassCastException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a ClassCastException and that has the given origin.

    Creates a non-null object that represent a ClassCastException and that has the given origin. If the ClassCastException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  10. final def ClassNotFoundException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
  11. def ClassValue(pc: PC, t: Type): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents a runtime value of type "Class<T>" and that was created by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents a runtime value of type "Class<T>" and that was created by the instruction with the specified program counter.

    This function is called by OPAL when a class constant (LDC(_W) instruction) is put on the stack.

    The domain may ignore the information about the value and the origin (vo).

    Summary

    The properties of the domain value are:

    • Initialized: Yes and the type represented by the class is the given type.
    • Type: java.lang.Class<t:Type>
    • Null: No
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  12. final val DomainReferenceValue: ClassTag[(DefaultReferenceValuesBinding.this)#DomainReferenceValue]

    Permalink

    The class tag can be used to create type safe arrays or to extract the concrete type of the domain value.

    The class tag can be used to create type safe arrays or to extract the concrete type of the domain value.

    val DomainReferenceValue(v) = value // of type "DomainValue"
    // v is now of the type DomainReferenceValue
    Definition Classes
    DefaultReferenceValuesBindingValuesDomain
  13. final val DomainValue: ClassTag[(DefaultReferenceValuesBinding.this)#DomainValue]

    Permalink

    The class tag for the type DomainValue.

    The class tag for the type DomainValue.

    Required to generate instances of arrays in which values of type DomainValue can be stored in a type-safe manner.

    Initialization

    In the sub-trait or class that fixes the type of DomainValue it is necessary to implement this abstract val using:

    val DomainValueTag : ClassTag[DomainValue] = implicitly

    (As of Scala 2.10 it is necessary that you do not use implicit in the subclass - it will compile, but fail at runtime.)

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  14. final def IllegalMonitorStateException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent an IllegalMonitorStateException and that has the given origin.

    Creates a non-null object that represent an IllegalMonitorStateException and that has the given origin. If the IllegalMonitorStateException was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  15. def InitializedArrayValue(pc: PC, arrayType: ArrayType, counts: Chain[Int]): (DefaultReferenceValuesBinding.this)#DomainArrayValue

    Permalink

    Factory method to create a DomainValue that represents an array that was successfully created and which has the given type.

    Factory method to create a DomainValue that represents an array that was successfully created and which has the given type.

    The domain may ignore the information about the origin (pc) and the precise size of each dimension.

    Summary

    The properties of the domain value are:

    • Type: Precise
    • Null: No
    • Content: Unknown
    counts

    The size of each dimension if available. counts may not be empty but may not contain information about all dimensions; the following condition always has to hold: counts.length <= arrayType.dimensions.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  16. def InitializedObjectValue(pc: PC, objectType: ObjectType): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents an initialized reference value of the given type and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents an initialized reference value of the given type and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    General Remarks

    The given type usually identifies a class type (not an interface type) that is not abstract, but in some cases (e.g. consider java.awt.Toolkit()) it may be useful/meaningful to relax this requirement and to state that the class precisely represents the runtime type – even so the class is abstract. However, such decisions need to be made by the domain.

    This method is used by the OPAL framework to create reference values that are normally internally created by the JVM (in particular exceptions such as NullPointExeception and ClassCastException). However, it can generally be used to create initialized objects/arrays.

    Summary

    The properties of the domain value are:

    • Initialized: Yes
    • Type: precise (i.e., this type is not an upper bound, the type correctly models the runtime type.)
    • Null: No (This value is not null.)
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  17. object IsNull

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  18. object IsPrecise

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  19. object MObjectValue

    Permalink
  20. final val MetaInformationUpdateIllegalValue: MetaInformationUpdate[(DefaultReferenceValuesBinding.this)#DomainIllegalValue]

    Permalink

    The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].

    The result of the merge of two incompatible values has to be reported as a MetaInformationUpdate[DomainIllegalValue].

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  21. def MethodHandle(origin: ValueOrigin, handle: MethodHandle): (DefaultReferenceValuesBinding.this)#DomainReferenceValue

    Permalink

    Called by the AI framework for each load constant method handle (org.opalj.br.instructions.LoadMethodHandle) instruction to get a representation of/a DomainValue that represents the handle.

    Called by the AI framework for each load constant method handle (org.opalj.br.instructions.LoadMethodHandle) instruction to get a representation of/a DomainValue that represents the handle.

    handle

    A valid method handle.

    returns

    An InitializedObjectValue(ObjectType.MethodHandle). Hence, this method needs to be overridden if resolution of MethodHandle based method calls should be performed.

    Definition Classes
    ReferenceValuesFactory
  22. def MethodType(origin: ValueOrigin, descriptor: MethodDescriptor): (DefaultReferenceValuesBinding.this)#DomainReferenceValue

    Permalink

    Called by the framework for each load constant method type (org.opalj.br.instructions.LoadMethodType) instruction to get a domain-specific representation of the method descriptor as a MethodType.

    Called by the framework for each load constant method type (org.opalj.br.instructions.LoadMethodType) instruction to get a domain-specific representation of the method descriptor as a MethodType.

    descriptor

    A valid method descriptor.

    returns

    An InitializedObjectValue(ObjectType.MethodType). Hence, this method needs to be overridden if resolution of MethodType based method calls should be performed.

    Definition Classes
    ReferenceValuesFactory
  23. final def NegativeArraySizeException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a NegativeArraySizeException and that has the given origin.

    Creates a non-null object that represent a NegativeArraySizeException and that has the given origin. If the NegativeArraySizeException was created by the VM while evaluating an instruction with the program counter pc you use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  24. def NewArray(pc: PC, counts: (DefaultReferenceValuesBinding.this)#Operands, arrayType: ArrayType): (DefaultReferenceValuesBinding.this)#DomainArrayValue

    Permalink

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Typical Usage

    This factory method is (implicitly) used, e.g., by OPAL when a multianewarray instruction is found.

    Summary

    The properties of the value are:

    • Type: Precise
    • Null: No
    • Size: Depending on the values in counts
    • Content: Empty (i.e., default values w.r.t. to the array's component type)
    Definition Classes
    TypeLevelReferenceValues
  25. def NewArray(pc: PC, count: (DefaultReferenceValuesBinding.this)#DomainValue, arrayType: ArrayType): (DefaultReferenceValuesBinding.this)#DomainArrayValue

    Permalink

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Factory method to create a new domain value that represents a newly created array (non-null) with the size determined by count that is empty.

    Typical Usage

    This factory method is (implicitly) used, e.g., by OPAL when a newarray instruction is found.

    Summary

    The properties of the value are:

    • Type: Precise
    • Null: No
    • Size: Count
    • Content: Empty (i.e., default values w.r.t. to the array's component type)
    Definition Classes
    TypeLevelReferenceValues
  26. def NewObject(pc: PC, objectType: ObjectType): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Creates a new DomainValue that represents a new, uninitialized instance of an object of the given type.

    Creates a new DomainValue that represents a new, uninitialized instance of an object of the given type. The object was created by the (NEW) instruction with the specified program counter.

    OPAL calls this method when it evaluates newobject instructions. If the bytecode is valid a call of one of the object's constructors will subsequently initialize the object.

    Summary

    The properties of the domain value are:

    • Initialized: no (only the memory is allocated for the object)
    • Type: precise (i.e., this type is not an upper bound, the type correctly models the runtime type.)
    • Null: No (This value is not null.)
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
    Note

    Instances of arrays are created by the newarray and multianewarray instructions and in both cases an exception may be thrown (e.g., NegativeArraySizeException).

  27. def NonNullObjectValue(pc: PC, objectType: ObjectType): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Represents a non-null reference value with the given type as an upper type bound.

    Represents a non-null reference value with the given type as an upper type bound.

    The domain may ignore the information about the value and the origin (vo).

    Summary

    The properties of the domain value are:

    • Initialized: Yes (the constructor was called)
    • Type: Upper Bound
    • Null: No (This value is not null.)
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  28. final def NullPointerException(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a NullPointerException and that has the given origin.

    Creates a non-null object that represent a NullPointerException and that has the given origin. If the NullPointerException was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  29. def NullValue(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#DomainNullValue

    Permalink

    Factory method to create a DomainValue that represents value null and and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents value null and and that was created (explicitly or implicitly) by the instruction with the specified program counter.

    The domain may ignore the information about the value and the origin (pc).

    Summary

    The properties of the domain value are:

    • Initialized: N/A
    • Type: Null
    • Null: Yes

    This implementation always returns the singleton instance TheNullValue.

    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValuesReferenceValuesFactory
  30. def ObjectValue(origin: ValueOrigin, upperTypeBound: UIDSet[ObjectType]): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents either an class-/interface value that has the given types as an upper bound or the value null.

    Factory method to create a DomainValue that represents either an class-/interface value that has the given types as an upper bound or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound and it is not known if the value is properly initialized.

    Summary

    The properties of the domain value are:

    • Initialized: Unknown (i.e., it is not guaranteed that the constructor was called.)
    • Type: Upper Bound
    • Null: Unknown
    • Content: Unknown
    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValues
  31. def ObjectValue(origin: ValueOrigin, objectType: ObjectType): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents either an class-/interface value that has the given type or the value null.

    Factory method to create a DomainValue that represents either an class-/interface value that has the given type or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound and it is not known if the value is properly initialized.

    Summary

    The properties of the domain value are:

    • Initialized: Unknown
    • Type: Upper Bound
    • Null: Unknown
    • Content: Unknown
    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValues
  32. def ReferenceValue(pc: PC, upperTypeBound: ReferenceType): (DefaultReferenceValuesBinding.this)#AReferenceValue

    Permalink

    Factory method to create a DomainValue that represents either a reference value that has the given type and is initialized or the value null.

    Factory method to create a DomainValue that represents either a reference value that has the given type and is initialized or the value null. However, the information whether the value is null or not is not available. Furthermore, the type may also just be an upper bound.

    The domain may ignore the information about the value and the origin, but it has to remain possible for the domain to identify the component type of an array.

    Summary

    The properties of the domain value are:

    • Initialized: Yes (if non-null the constructor was called/the array was initialized)
    • Type: Upper Bound
    • Null: Unknown
    • Content: Unknown
    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  33. final def ReturnAddressValue(address: Int): (DefaultReferenceValuesBinding.this)#ReturnAddressValue

    Permalink

    Factory method to create an instance of a ReturnAddressValue.

    Factory method to create an instance of a ReturnAddressValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  34. object SObjectValue

    Permalink
  35. def StringValue(pc: PC, value: String): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink

    Factory method to create a DomainValue that represents the given string value and that was created by the instruction with the specified program counter.

    Factory method to create a DomainValue that represents the given string value and that was created by the instruction with the specified program counter.

    This function is called by OPAL-AI when a string constant (LDC(_W) instruction) is put on the stack.

    The domain may ignore the information about the value and the origin (vo).

    Summary

    The properties of the domain value are:

    • Initialized: Yes and the String's value is the given value. The string may be empty (""), but it is never null.
    • Type: java.lang.String
    • Null: No
    value

    A non-null string. (The string may be empty, though.)

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesFactory
  36. final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]

    Permalink

    The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue.

    The result of merging two values should never be reported as a StructuralUpdate if the computed value is an IllegalValue. The JVM semantics guarantee that the value will not be used and, hence, continuing the interpretation is meaningless.

    Definition Classes
    ValuesDomain
    Note

    This method is solely defined for documentation purposes and to catch implementation errors early on.

  37. final val TheIllegalValue: (DefaultReferenceValuesBinding.this)#DomainIllegalValue

    Permalink

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  38. val TheNullValue: (DefaultReferenceValuesBinding.this)#DomainNullValue

    Permalink
  39. final val TheReturnAddressValues: (DefaultReferenceValuesBinding.this)#ReturnAddressValues

    Permalink

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  40. final def Throwable(origin: ValueOrigin): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink

    Creates a non-null object that represent a Throwable object and that has the given origin.

    Creates a non-null object that represent a Throwable object and that has the given origin. If the Throwable was created by the VM while evaluating an instruction with the program counter pc you should use the method ValueOriginForVMLevelValue to translate that pc to the appropriate ValueOrigin.

    Definition Classes
    DefaultExceptionsFactoryExceptionsFactory
  41. object UpperTypeBound

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  42. final def VMArithmeticException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  43. final def VMArrayIndexOutOfBoundsException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  44. final def VMArrayStoreException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  45. final def VMClassCastException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  46. final def VMClassNotFoundException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  47. final def VMIllegalMonitorStateException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  48. final def VMNegativeArraySizeException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  49. final def VMNullPointerException(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  50. final def VMThrowable(pc: PC): (DefaultReferenceValuesBinding.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  51. def aaload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  52. def aastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  53. def arraylength(pc: PC, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValue]

    Permalink

    Returns the array's length or throws a NullPointerException if the given reference is null.

    Returns the array's length or throws a NullPointerException if the given reference is null.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    It is in general not necessary to override this method. If you need some special handling refine the trait ArrayValue.

  54. def arrayload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink

    Loads the value stored in the array at the given index or throws an exception (NullPointerException or IndexOutOfBoundsException).

    Loads the value stored in the array at the given index or throws an exception (NullPointerException or IndexOutOfBoundsException).

    Definition Classes
    TypeLevelReferenceValuesGeneralizedArrayHandling
    Note

    It is in general not necessary to override this method. If you need some special handling refine the load method defined by the trait ArrayValue.

  55. def arraystore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink

    Stores the given value in the array at the given index or throws an exception (NullPointerException, ArrayStoreException or IndexOutOfBoundsException).

    Stores the given value in the array at the given index or throws an exception (NullPointerException, ArrayStoreException or IndexOutOfBoundsException).

    Definition Classes
    TypeLevelReferenceValuesGeneralizedArrayHandling
    Note

    It is in general not necessary to override this method. If you need some special handling refine the store method defined by the trait ArrayValue.

  56. def asArrayAbstraction(value: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayAbstraction

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  57. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  58. def asObjectValue(value: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#DomainObjectValue

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  59. def asReferenceValue(value: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#AReferenceValue

    Permalink

    Returns the given value as a DomainReferenceValue.

    Returns the given value as a DomainReferenceValue. Basically just performs a type cast and is intended to be used to communicate that the value has to be a reference value (if the underlying byte code is valid.)

    Definition Classes
    TypeLevelReferenceValues
  60. def baload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  61. def bastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  62. def caload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  63. def castore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  64. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. def daload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  66. def dastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  67. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  69. def faload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  70. def fastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  71. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  72. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  74. def iaload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  75. def iastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  76. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  77. final def isValueSubtypeOf(value: (DefaultReferenceValuesBinding.this)#DomainValue, supertype: ReferenceType): Answer

    Permalink

    Tries to determine – under the assumption that the given value is not null – if the runtime type of the given reference value could be a subtype of the specified reference type supertype.

    Tries to determine – under the assumption that the given value is not null – if the runtime type of the given reference value could be a subtype of the specified reference type supertype. I.e., if the type of the value is not precisely known, then all subtypes of the value's type are also taken into consideration when analyzing the subtype relation and only if we can guarantee that none is a subtype of the given supertype the answer will be No.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    The returned value is only meaningful if value does not represent the runtime value null.

  78. final def justThrows(value: (DefaultReferenceValuesBinding.this)#ExceptionValue): ThrowsException[(DefaultReferenceValuesBinding.this)#ExceptionValues]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  79. def laload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  80. def lastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  81. def mergeDEComputations(pc: PC, c1: Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValue], c2: Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValue]): Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValue]

    Permalink

    Merges two computations that both resulted in at most one DomainValue or at most one ExceptionValue.

    Merges two computations that both resulted in at most one DomainValue or at most one ExceptionValue.

    If values are merged the merged value will use the specified pc.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  82. def mergeDEsComputations(pc: PC, c1: Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValues], c2: Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValues]): Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValues]

    Permalink

    Merges two computations that both return some DomainValue and some ExceptionValues.

    Merges two computations that both return some DomainValue and some ExceptionValues. If values are merged the merged value will use the specified pc.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  83. def mergeDomainValues(pc: PC, v1: (DefaultReferenceValuesBinding.this)#DomainValue, v2: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#DomainValue

    Permalink

    Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.

    Merges the given domain value v1 with the domain value v2 and returns the merged value which is v1 if v1 is an abstraction of v2, v2 if v2 is an abstraction of v1 or some other value if a new value is computed that abstracts over both values.

    This operation is commutative.

    Definition Classes
    ValuesDomain
  84. def mergeEsComputations(pc: PC, c1: Computation[Nothing, (DefaultReferenceValuesBinding.this)#ExceptionValues], c2: Computation[Nothing, (DefaultReferenceValuesBinding.this)#ExceptionValues]): Computation[Nothing, (DefaultReferenceValuesBinding.this)#ExceptionValues]

    Permalink

    Merges two computations that both resulted in at most one ExceptionValue each.

    Merges two computations that both resulted in at most one ExceptionValue each.

    If values are merged the merged value will use the specified pc.

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  85. def mergeMultipleExceptionValues(pc: PC, v1s: (DefaultReferenceValuesBinding.this)#ExceptionValues, v2s: (DefaultReferenceValuesBinding.this)#ExceptionValues): (DefaultReferenceValuesBinding.this)#ExceptionValues

    Permalink

    Merges those exceptions that have the same upper type bound.

    Merges those exceptions that have the same upper type bound. This ensures that per upper type bound only one ValuesDomain.DomainValue (which may be a MultipleReferenceValues) is used. For those values that are merged, the given pc is used.

    Definition Classes
    TypeLevelReferenceValues
  86. def multianewarray(pc: PC, counts: (DefaultReferenceValuesBinding.this)#Operands, arrayType: ArrayType): Computation[(DefaultReferenceValuesBinding.this)#DomainArrayValue, (DefaultReferenceValuesBinding.this)#ExceptionValue]

    Permalink

    Creates a multi-dimensional array.

    Creates a multi-dimensional array.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    It is generally not necessary to override this method as it handles all cases in a generic manner.

    ,

    The componentType may be (again) an array type.

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

    Permalink
    Definition Classes
    AnyRef
  88. def newarray(pc: PC, count: (DefaultReferenceValuesBinding.this)#DomainValue, componentType: FieldType): Computation[(DefaultReferenceValuesBinding.this)#DomainValue, (DefaultReferenceValuesBinding.this)#ExceptionValue]

    Permalink

    Creates a new array.

    Creates a new array.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    It is generally not necessary to override this method as it handles all cases in a generic manner.

  89. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  91. def properties(pc: PC, propertyToString: (AnyRef) ⇒ String = (v) ⇒ v.toString): Option[String]

    Permalink

    Returns a string representation of the properties associated with the instruction with the respective program counter.

    Returns a string representation of the properties associated with the instruction with the respective program counter.

    Associating properties with an instruction and maintaining those properties is, however, at the sole responsibility of the Domain.

    This method is predefined to facilitate the development of support tools and is not used by the abstract interpretation framework.

    Domains that define (additional) properties should (abstract) override this method and should return a textual representation of the property.

    Definition Classes
    ValuesDomain
  92. def refAreEqual(pc: PC, value1: (DefaultReferenceValuesBinding.this)#DomainValue, value2: (DefaultReferenceValuesBinding.this)#DomainValue): Answer

    Permalink

    Tests if both values refer to the same object instance.

    Tests if both values refer to the same object instance.

    Though this is in general intractable, there are some cases where a definitive answer is possible.

    This implementation completely handles the case where at least one value definitively represents the null value. Additionally, if we have precise type information and the types are different, No is returned. Otherwise, Unknown is returned.

    value1

    A value of type ReferenceValue.

    value2

    A value of type ReferenceValue.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
    Note

    This method is intended to be overridden by subclasses and may be the first one that is called (by means of super) by the overriding method to handle checks related to null. E.g.

    super.areEqualReferences(value1,value2).ifUnknown {
        ...
    }
  93. def refAreNotEqual(pc: PC, value1: (DefaultReferenceValuesBinding.this)#DomainValue, value2: (DefaultReferenceValuesBinding.this)#DomainValue): Answer

    Permalink

    Compares the given values for reference inequality.

    Compares the given values for reference inequality. Returns No if both values point to the same instance and returns Yes if both objects are known not to point to the same instance. The latter is, e.g., trivially the case when both values have a different concrete type. Otherwise Unknown is returned.

    If both values are representing the null value the org.opalj.Answer is Yes.

    value1

    A value of computational type reference.

    value2

    A value of computational type reference.

    Definition Classes
    ReferenceValuesDomain
  94. def refEstablishAreEqual(pc: PC, value1: (DefaultReferenceValuesBinding.this)#DomainValue, value2: (DefaultReferenceValuesBinding.this)#DomainValue, operands: (DefaultReferenceValuesBinding.this)#Operands, locals: (DefaultReferenceValuesBinding.this)#Locals): ((DefaultReferenceValuesBinding.this)#Operands, (DefaultReferenceValuesBinding.this)#Locals)

    Permalink

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison succeeded.

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison succeeded.

    Definition Classes
    ReferenceValuesDomain
  95. def refEstablishAreNotEqual(pc: PC, value1: (DefaultReferenceValuesBinding.this)#DomainValue, value2: (DefaultReferenceValuesBinding.this)#DomainValue, operands: (DefaultReferenceValuesBinding.this)#Operands, locals: (DefaultReferenceValuesBinding.this)#Locals): ((DefaultReferenceValuesBinding.this)#Operands, (DefaultReferenceValuesBinding.this)#Locals)

    Permalink

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison failed.

    Called by OPAL when two values were compared for reference equality and we are going to analyze the branch where the comparison failed.

    Definition Classes
    ReferenceValuesDomain
  96. def refEstablishIsNonNull(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, operands: (DefaultReferenceValuesBinding.this)#Operands, locals: (DefaultReferenceValuesBinding.this)#Locals): ((DefaultReferenceValuesBinding.this)#Operands, (DefaultReferenceValuesBinding.this)#Locals)

    Permalink

    Called by OPAL-AI when it establishes that the value is guaranteed not to be null.

    Called by OPAL-AI when it establishes that the value is guaranteed not to be null. E.g., after a comparison with null OPAL can establish that the value has to be null on one branch and that the value is not null on the other branch.

    Definition Classes
    ReferenceValuesDomain
  97. def refEstablishIsNull(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, operands: (DefaultReferenceValuesBinding.this)#Operands, locals: (DefaultReferenceValuesBinding.this)#Locals): ((DefaultReferenceValuesBinding.this)#Operands, (DefaultReferenceValuesBinding.this)#Locals)

    Permalink

    Called by the framework when the value is known to be null/has to be null.

    Called by the framework when the value is known to be null/has to be null. E.g., after a comparison with null (IFNULL/IFNONNULL) OPAL-AI knows that the value has to be null on one branch and that the value is not null on the other branch.

    Definition Classes
    ReferenceValuesDomain
  98. def refIsNonNull(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue): Answer

    Permalink

    Returns Yes if given value is never null, Unknown if the values is maybe null and No otherwise.

    Returns Yes if given value is never null, Unknown if the values is maybe null and No otherwise.

    value

    A value of computational type reference.

    Definition Classes
    ReferenceValuesDomain
  99. final def refIsNull(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue): Answer

    Permalink

    Determines the nullness-property of the given value.

    Determines the nullness-property of the given value.

    value

    A value of type ReferenceValue.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
  100. def refSetUpperTypeBoundOfTopOperand(pc: PC, upperTypeBound: ReferenceType, operands: (DefaultReferenceValuesBinding.this)#Operands, locals: (DefaultReferenceValuesBinding.this)#Locals): ((DefaultReferenceValuesBinding.this)#Operands, (DefaultReferenceValuesBinding.this)#Locals)

    Permalink

    Called by the abstract interpreter when the type bound of the top most stack value needs to be refined.

    Called by the abstract interpreter when the type bound of the top most stack value needs to be refined. This method is only called by the abstract interpreter iff an immediately preceding subtype query (typeOf(value) <: bound) returned Unknown. This method must not be ignored – w.r.t. refining the top-most stack value; it is e.g., used by org.opalj.br.instructions.CHECKCAST instructions.

    A domain that is able to identify aliases can use this information to propagate the information to the other aliases.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
  101. def refTopOperandIsNull(pc: PC, operands: (DefaultReferenceValuesBinding.this)#Operands, locals: (DefaultReferenceValuesBinding.this)#Locals): ((DefaultReferenceValuesBinding.this)#Operands, (DefaultReferenceValuesBinding.this)#Locals)

    Permalink

    Sets the is null property of the top-most stack value to Yes.

    Sets the is null property of the top-most stack value to Yes. This method is called by the framework when the top-most operand stack value has to be null, but a previous isNull check returned Unknown. E.g., after a org.opalj.br.instructions.CHECKCAST that fails unless the value is "null".

    This method can be ignored; i.e., the return value can be (operands,locals). However, a domain that is able to identify aliases can use this information to propagate the information to the other aliases.

    Definition Classes
    TypeLevelReferenceValuesReferenceValuesDomain
  102. def saload(pc: PC, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayLoadResult

    Permalink
  103. def sastore(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue, index: (DefaultReferenceValuesBinding.this)#DomainValue, arrayref: (DefaultReferenceValuesBinding.this)#DomainValue): (DefaultReferenceValuesBinding.this)#ArrayStoreResult

    Permalink
  104. def summarize(pc: PC, values: Iterable[(DefaultReferenceValuesBinding.this)#DomainValue]): (DefaultReferenceValuesBinding.this)#DomainValue

    Permalink

    Creates a summary of the given domain values by summarizing and joining the given values.

    Creates a summary of the given domain values by summarizing and joining the given values. For the precise details regarding the calculation of a summary see Value.summarize(...).

    pc

    The program counter that will be used for the summary value if a new value is returned that abstracts over/summarizes the given values.

    values

    An Iterable over one or more values.

    Definition Classes
    ValuesDomain
    Note

    The current algorithm is generic and should satisfy most needs, but it is not very efficient. However, it should be easy to tailor it for a specific domain/domain values, if need be.

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

    Permalink
    Definition Classes
    AnyRef
  106. final def throws(value: (DefaultReferenceValuesBinding.this)#ExceptionValue): ThrowsException[(DefaultReferenceValuesBinding.this)#ExceptionValue]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  107. def toJavaObject(pc: PC, value: (DefaultReferenceValuesBinding.this)#DomainValue): Option[AnyRef]

    Permalink

    Converts – if possible – a given DomainValue to a Java object that is appropriately initialized.

    Converts – if possible – a given DomainValue to a Java object that is appropriately initialized.

    Implementation

    Every domain that supports the creation of a Java object's based on a domain value is expected to implement this method and to test if it can create a precise representation of the given value. If not, the implementation has to delegate the responsibility to the super method to creat an abstract representation.

    abstract override def toJavaObject(value : DomainValue): Option[Object] = {
     if(value...)
         // create and return Java object
     else
         super.toJavaObject(value)
    }
    returns

    Some(Object) is returned if it was possible to create a compatible corresponding Java object; otherwise None is returned. Default: None unless the value is null. In the latter case Some(null) is returned.

    Definition Classes
    TypeLevelReferenceValuesAsJavaObject
    Note

    This operation is generally only possible if the domain value maintains enough state information to completely initialize the Java object.

  108. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  109. def typeOfValue(value: (DefaultReferenceValuesBinding.this)#DomainValue): TypeInformation

    Permalink

    Returns the type(type bounds) of the given value.

    Returns the type(type bounds) of the given value.

    In general a single value can have multiple type bounds which depend on the control flow. However, all types that the value represents must belong to the same computational type category. I.e., it is possible that the value either has the type "NullPointerException or IllegalArgumentException", but it will never have – at the same time – the (Java) types int and long. Furthermore, it is possible that the returned type(s) is(are) only an upper bound of the real type unless the type is a primitive type.

    This default implementation always returns org.opalj.ai.UnknownType.

    Implementing typeOfValue

    This method is typically not implemented by a single Domain trait/object, but is instead implemented collaboratively by all domains that implement the semantics of certain values. To achieve that, other Domain traits that implement a concrete domain's semantics have to abstract override this method and only return the value's type if the domain knows anything about the type. If a method that overrides this method has no knowledge about the given value, it should delegate this call to its super method.

    Example

    trait FloatValues extends Domain[...] {
      ...
        abstract override def typeOfValue(value: DomainValue): TypesAnswer =
        value match {
          case r: FloatValue ⇒ IsFloatValue
          case _             ⇒ super.typeOfValue(value)
        }
    }
    Definition Classes
    ValuesDomain
  110. final def wait(): Unit

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

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

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

Inherited from DefaultExceptionsFactory

Inherited from TypeLevelReferenceValues

Inherited from AsJavaObject

Inherited from GeneralizedArrayHandling

Inherited from ReferenceValuesDomain

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from DefaultDomainValueBinding

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

Ungrouped