Class

org.opalj.ai.domain.l1

DefaultSetValuesDomain

Related Doc: package l1

Permalink

class DefaultSetValuesDomain[Source] extends CorrelationalDomain with TheProject with TheMethod with DefaultDomainValueBinding with ThrowAllPotentialExceptionsConfiguration with DefaultHandlingOfMethodResults with IgnoreSynchronization with DefaultTypeLevelFloatValues with DefaultTypeLevelDoubleValues with TypeLevelFieldAccessInstructions with TypeLevelInvokeInstructions with DefaultClassValuesBinding with NullPropertyRefinement with DefaultIntegerSetValues with DefaultLongSetValues with LongValuesShiftOperators with ConcretePrimitiveValuesConversions

This domain uses the l1 level stable, partial domains that represent the values of variables using sets.

Source
DefaultSetValuesDomain.scala
Linear Supertypes
ConcretePrimitiveValuesConversions, TypeLevelPrimitiveValuesConversions, LongValuesShiftOperators, DefaultLongSetValues, LongSetValues, ConcreteLongValues, DefaultIntegerSetValues, IntegerSetValues, IntegerRangeValuesFactory, ConcreteIntegerValues, NullPropertyRefinement, DefaultClassValuesBinding, ClassValues, DefaultStringValuesBinding, StringValues, PostEvaluationMemoryManagement, DefaultJavaObjectToDomainValueConversion, AsDomainValue, DefaultReferenceValuesBinding, DefaultExceptionsFactory, ReferenceValues, Origin, DefaultTypeLevelReferenceValues, TypeLevelReferenceValues, AsJavaObject, GeneralizedArrayHandling, TypeLevelInvokeInstructions, MethodCallsHandling, TypeLevelFieldAccessInstructions, DefaultTypeLevelDoubleValues, TypeLevelDoubleValues, DefaultTypeLevelFloatValues, TypeLevelFloatValues, IgnoreSynchronization, DefaultHandlingOfMethodResults, DefaultHandlingForReturnInstructions, DefaultHandlingOfVoidReturns, DefaultHandlingForThrownExceptions, ReturnInstructionsDomain, ThrowAllPotentialExceptionsConfiguration, DefaultDomainValueBinding, TheMethod, TheCode, TheProject, ThePropertyStore, LogContextProvider, TheClassHierarchy, CorrelationalDomain, CorrelationalDomainSupport, IdentityBasedCorrelationChangeDetection, JoinStabilization, Domain, Configuration, TypedValuesFactory, PrimitiveValuesConversionsDomain, ai.ReturnInstructionsDomain, MonitorInstructionsDomain, MethodCallsDomain, FieldAccessesDomain, ReferenceValuesDomain, ReferenceValuesFactory, ExceptionsFactory, DoubleValuesDomain, DoubleValuesFactory, FloatValuesDomain, FloatValuesFactory, LongValuesDomain, LongValuesFactory, IntegerValuesDomain, IntegerValuesFactory, CoreDomainFunctionality, SubroutinesDomain, ValuesDomain, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultSetValuesDomain
  2. ConcretePrimitiveValuesConversions
  3. TypeLevelPrimitiveValuesConversions
  4. LongValuesShiftOperators
  5. DefaultLongSetValues
  6. LongSetValues
  7. ConcreteLongValues
  8. DefaultIntegerSetValues
  9. IntegerSetValues
  10. IntegerRangeValuesFactory
  11. ConcreteIntegerValues
  12. NullPropertyRefinement
  13. DefaultClassValuesBinding
  14. ClassValues
  15. DefaultStringValuesBinding
  16. StringValues
  17. PostEvaluationMemoryManagement
  18. DefaultJavaObjectToDomainValueConversion
  19. AsDomainValue
  20. DefaultReferenceValuesBinding
  21. DefaultExceptionsFactory
  22. ReferenceValues
  23. Origin
  24. DefaultTypeLevelReferenceValues
  25. TypeLevelReferenceValues
  26. AsJavaObject
  27. GeneralizedArrayHandling
  28. TypeLevelInvokeInstructions
  29. MethodCallsHandling
  30. TypeLevelFieldAccessInstructions
  31. DefaultTypeLevelDoubleValues
  32. TypeLevelDoubleValues
  33. DefaultTypeLevelFloatValues
  34. TypeLevelFloatValues
  35. IgnoreSynchronization
  36. DefaultHandlingOfMethodResults
  37. DefaultHandlingForReturnInstructions
  38. DefaultHandlingOfVoidReturns
  39. DefaultHandlingForThrownExceptions
  40. ReturnInstructionsDomain
  41. ThrowAllPotentialExceptionsConfiguration
  42. DefaultDomainValueBinding
  43. TheMethod
  44. TheCode
  45. TheProject
  46. ThePropertyStore
  47. LogContextProvider
  48. TheClassHierarchy
  49. CorrelationalDomain
  50. CorrelationalDomainSupport
  51. IdentityBasedCorrelationChangeDetection
  52. JoinStabilization
  53. Domain
  54. Configuration
  55. TypedValuesFactory
  56. PrimitiveValuesConversionsDomain
  57. ReturnInstructionsDomain
  58. MonitorInstructionsDomain
  59. MethodCallsDomain
  60. FieldAccessesDomain
  61. ReferenceValuesDomain
  62. ReferenceValuesFactory
  63. ExceptionsFactory
  64. DoubleValuesDomain
  65. DoubleValuesFactory
  66. FloatValuesDomain
  67. FloatValuesFactory
  68. LongValuesDomain
  69. LongValuesFactory
  70. IntegerValuesDomain
  71. IntegerValuesFactory
  72. CoreDomainFunctionality
  73. SubroutinesDomain
  74. ValuesDomain
  75. AnyRef
  76. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultSetValuesDomain(project: Project[Source], method: Method)

    Permalink

Type Members

  1. class ALongValue extends (DefaultLongSetValues.this)#ALongValue

    Permalink
    Definition Classes
    DefaultLongSetValues
  2. type AReferenceValue = ReferenceValue

    Permalink
  3. class AnIntegerValue extends (DefaultIntegerSetValues.this)#AnIntegerValue

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  4. trait ArrayAbstraction extends AnyRef

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  5. type ArrayLoadResult = Computation[DomainValue, 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
  6. type ArrayStoreResult = Computation[Nothing, 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
  7. class ArrayValue extends (ReferenceValues.this)#ArrayValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  8. trait BaseTypesBasedSet extends (DefaultIntegerSetValues.this)#IntegerLikeValue with (DefaultIntegerSetValues.this)#BaseTypesBasedSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  9. class ByteSet extends (DefaultIntegerSetValues.this)#ByteSet with (DefaultIntegerSetValues.this)#BaseTypesBasedSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  10. class CharSet extends (DefaultIntegerSetValues.this)#CharSet with (DefaultIntegerSetValues.this)#BaseTypesBasedSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  11. class ClassValue extends (ClassValues.this)#SObjectValue

    Permalink

    All values (Class<...> c) that represent the same type (e.g.

    All values (Class<...> c) that represent the same type (e.g. java.lang.String) are actually represented by the same class (object) value at runtime.

    Attributes
    protected
    Definition Classes
    ClassValues
  12. type DomainArrayValue = ArrayValue

    Permalink
  13. type DomainBaseTypesBasedSet = BaseTypesBasedSet

    Permalink
  14. type DomainClassValue = ClassValue

    Permalink
    Definition Classes
    DefaultClassValuesBindingClassValues
  15. final type DomainIllegalValue = 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
  16. type DomainMultipleReferenceValues = MultipleReferenceValues

    Permalink
  17. type DomainNullValue = NullValue

    Permalink
  18. type DomainObjectValue = ObjectValue

    Permalink
  19. type DomainReferenceValue = ReferenceValue

    Permalink
  20. final type DomainReturnAddressValue = 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
  21. final type DomainReturnAddressValues = ReturnAddressValues

    Permalink
  22. type DomainSingleOriginReferenceValue = SingleOriginReferenceValue

    Permalink
  23. type DomainStringValue = StringValue

    Permalink
  24. final type DomainTypedValue[+T <: Type] = TypedValue[T]

    Permalink
  25. final type DomainValue = 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
  26. trait DoubleValue extends (TypeLevelDoubleValues.this)#TypedValue[DoubleType] with IsDoubleValue[(TypeLevelDoubleValues.this)#DoubleValue]

    Permalink

    Abstracts over double values at the type level.

    Abstracts over double values at the type level.

    Definition Classes
    TypeLevelDoubleValues
  27. type ExceptionValue = 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
  28. type ExceptionValues = Iterable[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
  29. trait FloatValue extends (TypeLevelFloatValues.this)#TypedValue[FloatType] with IsFloatValue[(TypeLevelFloatValues.this)#FloatValue]

    Permalink

    Abstracts over all values with computational type float.

    Abstracts over all values with computational type float.

    Definition Classes
    TypeLevelFloatValues
  30. 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.

  31. abstract class IntegerLikeValue extends (IntegerSetValues.this)#TypedValue[CTIntType] with IsIntegerValue[(IntegerSetValues.this)#IntegerLikeValue]

    Permalink

    Abstracts over all values with computational type integer.

    Abstracts over all values with computational type integer.

    Definition Classes
    IntegerSetValues
  32. class IntegerSet extends (DefaultIntegerSetValues.this)#IntegerSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  33. type IntegerValueOrArithmeticException = Computation[DomainValue, ExceptionValue]

    Permalink

    Computation that returns a numeric value or an ObjectType.ArithmeticException.

    Computation that returns a numeric value or an ObjectType.ArithmeticException.

    Definition Classes
    IntegerValuesDomain
  34. type Locals = collection.mutable.Locals[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
  35. type LocalsArray = Array[Locals]

    Permalink
    Definition Classes
    ValuesDomain
  36. class LongSet extends (DefaultLongSetValues.this)#LongSet

    Permalink
    Definition Classes
    DefaultLongSetValues
  37. sealed trait LongValue extends (LongSetValues.this)#TypedValue[LongType] with IsLongValue[(LongSetValues.this)#LongValue]

    Permalink

    Abstracts over all values with computational type long.

    Abstracts over all values with computational type long.

    Definition Classes
    LongSetValues
  38. type LongValueOrArithmeticException = Computation[DomainValue, ExceptionValue]

    Permalink
    Definition Classes
    LongValuesDomain
  39. class MObjectValue extends (ReferenceValues.this)#MObjectValue with (ReferenceValues.this)#ObjectValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  40. type MethodCallResult = Computation[DomainValue, ExceptionValues]

    Permalink
    Definition Classes
    MethodCallsDomain
  41. trait MultipleOriginsValue extends (Origin.this)#ValueWithOriginInformation

    Permalink

    Should be mixed in by Value classes that capture information about all origins of a value.

    Should be mixed in by Value classes that capture information about all origins of a value.

    Definition Classes
    Origin
  42. class MultipleReferenceValues extends (ReferenceValues.this)#ReferenceValue with (ReferenceValues.this)#MultipleOriginsValue

    Permalink

    A MultipleReferenceValues tracks multiple reference values (of type NullValue, ArrayValue, SObjectValue and MObjectValue) that have different origins.

    A MultipleReferenceValues tracks multiple reference values (of type NullValue, ArrayValue, SObjectValue and MObjectValue) that have different origins. I.e., per value origin one domain value is used to abstract over the properties of that respective value.

    Attributes
    protected
    Definition Classes
    ReferenceValues
  43. trait NonNullSingleOriginReferenceValue extends (ReferenceValues.this)#SingleOriginReferenceValue

    Permalink
    Definition Classes
    ReferenceValues
  44. trait NonNullSingleOriginSReferenceValue extends (ReferenceValues.this)#NonNullSingleOriginReferenceValue

    Permalink
    Definition Classes
    ReferenceValues
  45. class NullValue extends (ReferenceValues.this)#NullValue with (ReferenceValues.this)#SingleOriginReferenceValue

    Permalink
    Attributes
    protected
    Definition Classes
    ReferenceValues
  46. trait ObjectValue extends (ReferenceValues.this)#ObjectValue with (ReferenceValues.this)#NonNullSingleOriginReferenceValue

    Permalink
    Definition Classes
    ReferenceValues
  47. type Operands = Chain[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
  48. type OperandsArray = Array[Operands]

    Permalink
    Definition Classes
    ValuesDomain
  49. trait RETValue extends Value

    Permalink
    Definition Classes
    ValuesDomain
  50. trait ReferenceValue extends (ReferenceValues.this)#ReferenceValue

    Permalink

    Representation of some reference value; this includes Object, Array and Null values.

    Representation of some reference value; this includes Object, Array and Null values.

    This trait defines the additional methods needed for the refinement of the new properties.

    Definition Classes
    ReferenceValues
  51. type Refinements = IdentityHashMap[AReferenceValue, AReferenceValue]

    Permalink

    A map that contains the refined values (the map's values) of some old values (the map's keys).

    A map that contains the refined values (the map's values) of some old values (the map's keys).

    Definition Classes
    ReferenceValues
  52. 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.

  53. 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
  54. class SObjectValue extends (ReferenceValues.this)#SObjectValue with (ReferenceValues.this)#ObjectValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue

    Permalink

    Attributes
    protected
    Definition Classes
    ReferenceValues
  55. 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
  56. class ShortSet extends (DefaultIntegerSetValues.this)#ShortSet with (DefaultIntegerSetValues.this)#BaseTypesBasedSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  57. trait SingleOriginReferenceValue extends (ReferenceValues.this)#ReferenceValue with (ReferenceValues.this)#SingleOriginValue with UID

    Permalink

    Represents all DomainReferenceValues that represent a reference value where – in the current analysis context – the value has a single origin.

    Represents all DomainReferenceValues that represent a reference value where – in the current analysis context – the value has a single origin.

    Definition Classes
    ReferenceValues
    Note

    To make it possible to store SingleOriginReferenceValues in UIDSets - which in particular provide fast filter and tail methods compared to the standard sets - the UID trait is implemented.

  58. trait SingleOriginValue extends (Origin.this)#ValueWithOriginInformation

    Permalink

    Should be mixed in by Values that have a single origin.

    Should be mixed in by Values that have a single origin.

    Definition Classes
    Origin
  59. class StringValue extends (StringValues.this)#SObjectValue

    Permalink

    Attributes
    protected
    Definition Classes
    StringValues
  60. type Timestamp = Int

    Permalink

    The timestamp enables us to distinguish two values created/returned by the same instruction (two values with the same origin) but at a different point in time.

    The timestamp enables us to distinguish two values created/returned by the same instruction (two values with the same origin) but at a different point in time.

    Such values may or may not be different (i.e., those value may or may not refer to the same object on the heap/stack).

    However, two domain values that have the same timestamp are guaranteed to refer to the same object at runtime (must-alias).

    Timestamps are required to determine changes in the memory layout. I.e., to determine if two values created by the same instruction are aliases or "just" maybe aliases. This information is particularly relevant if two values - stored in registers - are no longer guaranteed to be aliases!

    Definition Classes
    ReferenceValues
  61. trait TypedValue[+T <: Type] extends Value with KnownType

    Permalink
    Definition Classes
    ValuesDomain
  62. class U15BitSet extends (DefaultIntegerSetValues.this)#U15BitSet with (DefaultIntegerSetValues.this)#BaseTypesBasedSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  63. class U7BitSet extends (DefaultIntegerSetValues.this)#U7BitSet with (DefaultIntegerSetValues.this)#BaseTypesBasedSet

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  64. 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.

  65. trait ValueWithOriginInformation extends AnyRef

    Permalink
    Definition Classes
    Origin

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. object ADoubleValue extends (DefaultTypeLevelDoubleValues.this)#DoubleValue with Product with Serializable

    Permalink

    Represents an unknown double value.

    Represents an unknown double value.

    Definition Classes
    DefaultTypeLevelDoubleValues
  5. object AFloatValue extends (DefaultTypeLevelFloatValues.this)#FloatValue with Product with Serializable

    Permalink
    Definition Classes
    DefaultTypeLevelFloatValues
  6. final val AReferenceValue: ClassTag[AReferenceValue]

    Permalink
  7. def AnIntegerValue(): AnIntegerValue

    Permalink
    Definition Classes
    DefaultIntegerSetValues
  8. final def ArithmeticException(origin: ValueOrigin): 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
  9. final def ArrayIndexOutOfBoundsException(origin: ValueOrigin): 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
  10. final def ArrayStoreException(origin: ValueOrigin): 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
  11. def ArrayValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ArrayType, t: Timestamp): DomainArrayValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  12. def ArrayValue(pc: PC, arrayType: ArrayType): 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
    ReferenceValuesTypeLevelReferenceValues
    Note

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

  13. object ArrayValue

    Permalink

    Enables matching of DomainValues that are array values.

    Enables matching of DomainValues that are array values.

    Definition Classes
    DefaultTypeLevelReferenceValues
  14. def BooleanValue(pc: PC, value: Boolean): DomainTypedValue[CTIntType]

    Permalink

    Factory method to create a representation of a boolean value with the given initial value and origin.

    Factory method to create a representation of a boolean value with the given initial value and origin.

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

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  15. def BooleanValue(pc: PC): IntegerLikeValue

    Permalink

    Factory method to create a representation of a boolean value if we know the origin of the value.

    Factory method to create a representation of a boolean value if we know the origin of the value.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  16. def ByteValue(pc: PC, value: Byte): DomainTypedValue[CTIntType]

    Permalink

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

    Factory method to create a DomainValue that represents the given byte value 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 (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  17. def ByteValue(pc: PC): ByteSet

    Permalink

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

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

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  18. def CharValue(pc: PC, value: Char): DomainTypedValue[CTIntType]

    Permalink

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

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

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  19. def CharValue(pc: PC): CharSet

    Permalink

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

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

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  20. final def ClassCastException(origin: ValueOrigin): 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
  21. final def ClassNotFoundException(origin: ValueOrigin): ExceptionValue

    Permalink
  22. def ClassValue(origin: ValueOrigin, value: Type, t: Timestamp): DomainClassValue

    Permalink
    Definition Classes
    DefaultClassValuesBinding
  23. def ClassValue(origin: ValueOrigin, value: Type): DomainClassValue

    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
    DefaultClassValuesBindingClassValuesReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  24. object ClassValue

    Permalink
    Definition Classes
    ClassValues
  25. object ConcreteIntegerValue

    Permalink
    Definition Classes
    ConcreteIntegerValues
  26. object ConcreteLongValue

    Permalink
    Definition Classes
    ConcreteLongValues
  27. final def ConstantFieldValue(pc: PC, cv: ConstantFieldValue[_]): DomainValue

    Permalink

    Creates the domain value that represents the constant field value.

    Creates the domain value that represents the constant field value.

    Definition Classes
    Domain
  28. final def DefaultValue(origin: ValueOrigin, theType: FieldType): DomainValue

    Permalink

    Creates a DomainValue that represents a value with the given type and which is initialized using the JVM's default value for that type.

    Creates a DomainValue that represents a value with the given type and which is initialized using the JVM's default value for that type. E.g., for IntegerValues the value is set to 0. In case of a ReferenceType the value is the ReferenceValuesFactory#NullValue.

    Definition Classes
    TypedValuesFactory
  29. final val DomainArrayValue: ClassTag[DomainArrayValue]

    Permalink
  30. val DomainBaseTypesBasedSet: ClassTag[DomainBaseTypesBasedSet]

    Permalink
  31. val DomainClassValue: ClassTag[DomainClassValue]

    Permalink
    Definition Classes
    DefaultClassValuesBindingClassValues
  32. final val DomainMultipleReferenceValues: ClassTag[DomainMultipleReferenceValues]

    Permalink
  33. final val DomainNullValue: ClassTag[DomainNullValue]

    Permalink
  34. final val DomainObjectValue: ClassTag[DomainObjectValue]

    Permalink
  35. final val DomainReferenceValue: ClassTag[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
  36. final val DomainSingleOriginReferenceValue: ClassTag[DomainSingleOriginReferenceValue]

    Permalink
  37. implicit object DomainSingleOriginReferenceValueOrdering extends Ordering[(ReferenceValues.this)#DomainSingleOriginReferenceValue]

    Permalink

    Defines a total order on reference values with a single origin by subtracting both origins.

    Defines a total order on reference values with a single origin by subtracting both origins.

    Definition Classes
    ReferenceValues
  38. final val DomainStringValue: ClassTag[DomainStringValue]

    Permalink
  39. final val DomainValue: ClassTag[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
  40. final def DoubleValue(valueOrigin: ValueOrigin, value: Double): DoubleValue

    Permalink

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

    Factory method to create a DomainValue that represents the given double value 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 (vo).

    Definition Classes
    DefaultTypeLevelDoubleValuesDoubleValuesFactory
  41. final def DoubleValue(valueOrigin: ValueOrigin): DoubleValue

    Permalink

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter, but where we have no knowledge about the precise value.

    Factory method to create a DomainValue that was created (explicitly or implicitly) by the instruction with the specified program counter, but where we have no knowledge about the precise value.

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

    Definition Classes
    DefaultTypeLevelDoubleValuesDoubleValuesFactory
  42. def FloatValue(valueOrigin: ValueOrigin, value: Float): FloatValue

    Permalink

    Factory method to create a DomainValue with the specified origin.

    Factory method to create a DomainValue with the specified origin. The origin is typically the program counter of the instruction that created this value/where the value was observed for the first time.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelFloatValuesFloatValuesFactory
  43. def FloatValue(valueOrigin: ValueOrigin): FloatValue

    Permalink

    Factory method to create a DomainValue with the specified origin.

    Factory method to create a DomainValue with the specified origin. The origin is typically the program counter of the instruction that created this value/where the value was observed for the first time.

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultTypeLevelFloatValuesFloatValuesFactory
  44. final def IllegalMonitorStateException(origin: ValueOrigin): 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
  45. def InitializedArrayValue(pc: PC, arrayType: ArrayType, counts: Chain[Int]): 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
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  46. def InitializedObjectValue(pc: PC, objectType: ObjectType): 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
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  47. final def IntegerConstant0: DomainTypedValue[CTIntType]

    Permalink

    Factory method to create a representation of the integer constant value 0.

    Factory method to create a representation of the integer constant value 0.

    OPAL in particular uses this special value for performing subsequent computations against the fixed value 0 (e.g., for if_XX instructions).

    (The origin (ValueOrigin) that is used is the ConstantValueOrigin to signify that this value was not created by the program.)

    The domain may ignore the information about the value.

    Definition Classes
    IntegerValuesFactory
  48. def IntegerRange(origin: ValueOrigin, lowerBound: Int, upperBound: Int): DomainTypedValue[CTIntType]

    Permalink

    Creates a new IntegerSet value containing all values within the given bounds of the IntegerRange, as long as they don't exceed maxCardinalityOfIntegerSets.

    Creates a new IntegerSet value containing all values within the given bounds of the IntegerRange, as long as they don't exceed maxCardinalityOfIntegerSets.

    Definition Classes
    IntegerSetValuesIntegerRangeValuesFactory
  49. def IntegerSet(values: SortedSet[Int]): IntegerSet

    Permalink

    Creates a new IntegerSet value using the given set unless the set exceeds the maximum cardinality.

    Creates a new IntegerSet value using the given set unless the set exceeds the maximum cardinality.

    Definition Classes
    DefaultIntegerSetValuesIntegerSetValues
  50. def IntegerSet(origin: ValueOrigin, values: SortedSet[Int]): DomainTypedValue[CTIntType]

    Permalink

    Creates a new IntegerSet value using the given set unless the set exceeds the maximum cardinality.

    Creates a new IntegerSet value using the given set unless the set exceeds the maximum cardinality.

    Definition Classes
    IntegerSetValues
  51. def IntegerSet(value: Int): DomainTypedValue[CTIntType]

    Permalink

    Creates a new IntegerSet value containing the given value.

    Creates a new IntegerSet value containing the given value.

    Definition Classes
    IntegerSetValues
  52. object IntegerSet

    Permalink

    Extractor for IntegerSet values.

    Extractor for IntegerSet values.

    Definition Classes
    IntegerSetValues
  53. def IntegerValue(pc: PC, value: Int): DomainTypedValue[CTIntType]

    Permalink

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

    Factory method to create a DomainValue that represents the given integer value 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 (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  54. def IntegerValue(pc: PC): AnIntegerValue

    Permalink

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

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

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  55. object IsNull

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  56. object IsPrecise

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  57. def LongSet(values: SortedSet[Long]): LongSet

    Permalink

    Factory method to create a new LongSet value using the given set.

    Factory method to create a new LongSet value using the given set.

    Definition Classes
    DefaultLongSetValuesLongSetValues
  58. def LongSet(value: Long): DomainTypedValue[LongType]

    Permalink

    Factory method to create a new LongSet value containing just the given value.

    Factory method to create a new LongSet value containing just the given value.

    Definition Classes
    LongSetValues
  59. object LongSet

    Permalink

    Extractor for LongSet values.

    Extractor for LongSet values.

    Definition Classes
    LongSetValues
  60. def LongValue(origin: ValueOrigin, value: Long): LongSet

    Permalink

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

    Factory method to create a DomainValue that represents the given long value 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 (vo).

    Definition Classes
    DefaultLongSetValuesLongValuesFactory
  61. def LongValue(origin: ValueOrigin): ALongValue

    Permalink

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

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

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

    Definition Classes
    DefaultLongSetValuesLongValuesFactory
  62. object MObjectValue

    Permalink
  63. final val MetaInformationUpdateIllegalValue: MetaInformationUpdate[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
  64. def MethodCallResult(potentialExceptions: Iterable[ExceptionValue]): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  65. def MethodCallResult(returnValue: DomainValue, exceptions: Iterable[ExceptionValue]): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  66. def MethodHandle(origin: ValueOrigin, handle: MethodHandle): 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
  67. def MethodType(origin: ValueOrigin, descriptor: MethodDescriptor): 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
  68. def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue], isNull: Answer, isPrecise: Boolean, theUpperTypeBound: UIDSet[_ <: ReferenceType], t: Timestamp): DomainMultipleReferenceValues

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  69. def MultipleReferenceValues(values: UIDSet[DomainSingleOriginReferenceValue]): DomainMultipleReferenceValues

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  70. object MultipleReferenceValues

    Permalink
    Definition Classes
    ReferenceValues
  71. final def NegativeArraySizeException(origin: ValueOrigin): 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
  72. def NewArray(pc: PC, counts: Operands, arrayType: ArrayType): 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
    ReferenceValuesTypeLevelReferenceValues
  73. def NewArray(pc: PC, count: DomainValue, arrayType: ArrayType): 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
    ReferenceValuesTypeLevelReferenceValues
  74. def NewObject(origin: ValueOrigin, objectType: ObjectType): 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
    StringValuesReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
    Note

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

  75. def NonNullObjectValue(pc: PC, objectType: ObjectType): 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
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  76. final def NullPointerException(origin: ValueOrigin): 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
  77. def NullValue(origin: ValueOrigin): 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
    Definition Classes
    DefaultReferenceValuesBindingTypeLevelReferenceValuesReferenceValuesFactory
  78. def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType], t: Timestamp): DomainObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  79. def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType, t: Timestamp): SObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    DefaultReferenceValuesBindingReferenceValues
  80. def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType): DomainObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  81. def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType]): DomainObjectValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  82. def ObjectValue(pc: PC, upperTypeBound: UIDSet[ObjectType]): 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
    ReferenceValuesTypeLevelReferenceValues
  83. def ObjectValue(pc: PC, objectType: ObjectType): 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
    ReferenceValuesTypeLevelReferenceValues
  84. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, upperTypeBound: UIDSet[_ <: ReferenceType], t: Timestamp): DomainSingleOriginReferenceValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  85. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType): DomainSingleOriginReferenceValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  86. def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType, t: Timestamp): DomainSingleOriginReferenceValue

    Permalink
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  87. def ReferenceValue(pc: PC, upperTypeBound: ReferenceType): 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
  88. final def ReturnAddressValue(address: Int): ReturnAddressValue

    Permalink

    Factory method to create an instance of a ReturnAddressValue.

    Factory method to create an instance of a ReturnAddressValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  89. object SObjectValue

    Permalink
  90. def ShortValue(pc: PC, value: Short): DomainTypedValue[CTIntType]

    Permalink

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

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

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  91. def ShortValue(pc: PC): ShortSet

    Permalink

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

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

    The domain may ignore the information about the origin (origin).

    Definition Classes
    DefaultIntegerSetValuesIntegerValuesFactory
  92. implicit object SingleOriginValueOrdering extends Ordering[(Origin.this)#SingleOriginValue]

    Permalink
    Definition Classes
    Origin
  93. def StringValue(origin: ValueOrigin, value: String, t: Timestamp): DomainStringValue

    Permalink
  94. final def StringValue(origin: ValueOrigin, value: String): 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
    StringValuesReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  95. object StringValue

    Permalink
    Definition Classes
    StringValues
  96. 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.

  97. object T

    Permalink

    Extractor for timestamps.

    Extractor for timestamps.

    Definition Classes
    ReferenceValues
  98. final val TheIllegalValue: DomainIllegalValue

    Permalink

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  99. final val TheReturnAddressValues: ReturnAddressValues

    Permalink

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  100. final def Throwable(origin: ValueOrigin): 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
  101. final def TimestampUpdate[T](value: T): MetaInformationUpdate[T]

    Permalink

    Creates an update object that characterizes a timestamp update.

    Creates an update object that characterizes a timestamp update.

    Basically, just a wrapper for a MetaInformationUpdate; the purpose is to better communicate the underlying purpose.

    Definition Classes
    ReferenceValues
    Annotations
    @inline()
  102. def TypedValue(origin: ValueOrigin, valueType: Type): DomainValue

    Permalink

    Factory method to create domain values with a specific type.

    Factory method to create domain values with a specific type. I.e., values for which we have some type information but no precise value or source information. However, the value is guaranteed to be null or properly initialized.

    For example, if valueType is a reference type it may be possible that the actual value is null, but such knowledge is not available.

    The framework uses this method when a method is to be analyzed, but no parameter values are given and initial values need to be generated. This method is not used elsewhere by the framework.

    Definition Classes
    TypedValuesFactory
  103. def U15BitSet(): DomainTypedValue[CTIntType]

    Permalink
  104. def U7BitSet(): DomainTypedValue[CTIntType]

    Permalink
  105. object UpperTypeBound

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  106. final def VMArithmeticException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  107. final def VMArrayIndexOutOfBoundsException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  108. final def VMArrayStoreException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  109. final def VMClassCastException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  110. final def VMClassNotFoundException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  111. final def VMIllegalMonitorStateException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  112. final def VMNegativeArraySizeException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  113. final def VMNullPointerException(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  114. final def VMThrowable(pc: PC): ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  115. def aaload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  116. def aastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  117. def abruptMethodExecution(pc: PC, exception: 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
    DefaultHandlingForThrownExceptionsReturnInstructionsDomain
    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.

  118. def abstractInterpretationEnded(aiResult: AIResult { val domain: DefaultSetValuesDomain.this.type }): Unit

    Permalink

    Called by the abstract interpreter when the abstract interpretation of a method has ended.

    Called by the abstract interpreter when the abstract interpretation of a method has ended. The abstract interpretation of a method ends if either the fixpoint is reached or the interpretation was aborted.

    By default this method does nothing.

    Domains that override this method are expected to also call super.abstractInterpretationEnded(aiResult).

    Definition Classes
    CoreDomainFunctionality
  119. def afterBaseJoin(pc: PC): Unit

    Permalink

    This method is called after all values which differ have been joined, but before joinPostProcessing will be called.

    This method is called after all values which differ have been joined, but before joinPostProcessing will be called.

    Attributes
    protected[this]
    Definition Classes
    JoinStabilizationCoreDomainFunctionality
  120. def afterEvaluation(pc: PC, instruction: Instruction, oldOperands: Operands, oldLocals: Locals, targetPC: PC, isExceptionalControlFlow: Boolean, newOperands: Operands, newLocals: Locals): (Operands, Locals)

    Permalink

    This methods is called after the evaluation of the instruction with the given pc with respect to targetPC, but before the values are propagated (joined) and before it is checked whether the interpretation needs to be continued.

    This methods is called after the evaluation of the instruction with the given pc with respect to targetPC, but before the values are propagated (joined) and before it is checked whether the interpretation needs to be continued. I.e., if the operands (newOperands) or locals (newLocals) are further refined then the refined operands and locals are joined (if necessary).

    Definition Classes
    NullPropertyRefinementCoreDomainFunctionality
    Note

    During the evaluation of the instruction it is possible that this method is called multiple times with different targetPCs. The latter is not only true for control flow instructions, but also for those instructions that may raise an exception. This method can and is intended to be overridden to further refine the operand stack/the locals. However, the overriding method should always forward the (possibly refined) operands and locals to the super method (stackable traits).

  121. def approximateSet(origin: ValueOrigin, lb: Int, ub: Int): DomainTypedValue[CTIntType]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    IntegerSetValues
  122. def areturn(pc: PC, value: DomainValue): Computation[Nothing, 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
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  123. def arraylength(pc: PC, arrayref: DomainValue): Computation[DomainValue, 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.

  124. def arrayload(pc: PC, index: DomainValue, arrayref: DomainValue): 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.

  125. def arraystore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): 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.

  126. def asArrayAbstraction(value: DomainValue): ArrayAbstraction

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

    Permalink
    Definition Classes
    Any
  128. def asObjectValue(value: DomainValue): DomainObjectValue

    Permalink
    Definition Classes
    TypeLevelReferenceValues
  129. def asReferenceValue(value: DomainValue): 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
  130. def baload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  131. def bastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  132. def beforeBaseJoin(pc: PC): Unit

    Permalink

    This method is called immediately before a join operation with regard to the specified pc is performed.

    This method is called immediately before a join operation with regard to the specified pc is performed.

    Attributes
    protected[this]
    Definition Classes
    CoreDomainFunctionality
    Note

    This method is intended to be overwritten by clients to perform custom operations.

  133. def caload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  134. def castore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  135. final def classFile: ClassFile

    Permalink
    Definition Classes
    TheMethod
    Annotations
    @inline()
  136. implicit final def classHierarchy: ClassHierarchy

    Permalink

    Returns the project's class hierarchy.

    Returns the project's class hierarchy.

    Definition Classes
    TheProjectTheClassHierarchy
    Annotations
    @inline()
  137. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  138. final val code: Code

    Permalink

    Returns the code block that is currently analyzed.

    Returns the code block that is currently analyzed.

    Definition Classes
    TheMethodTheCode
  139. def createIntegerValueOrArithmeticException(pc: br.PC, exception: Boolean, results: SortedSet[Int]): IntegerValueOrArithmeticException

    Permalink
    Attributes
    protected[this]
    Definition Classes
    IntegerSetValues
  140. def createLongValueOrArithmeticException(pc: br.PC, exception: Boolean, results: SortedSet[Long]): LongValueOrArithmeticException

    Permalink
    Attributes
    protected[this]
    Definition Classes
    LongSetValues
  141. def d2f(pc: PC, value: DomainValue): DomainValue

    Permalink
  142. def d2i(pc: PC, value: DomainValue): DomainValue

    Permalink
  143. def d2l(pc: PC, value: DomainValue): DomainValue

    Permalink
  144. def dadd(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  145. def daload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  146. def dastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  147. def dcmpg(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  148. def dcmpl(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  149. def ddiv(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  150. def dmul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  151. def dneg(pc: PC, value: DomainValue): DomainValue

    Permalink
  152. def doGetfield(pc: PC, objectref: DomainValue, fieldValue: DomainValue): Computation[DomainValue, ExceptionValue]

    Permalink
  153. def doGetstatic(pc: PC, fieldValue: DomainValue): Computation[DomainValue, Nothing]

    Permalink
  154. def drem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  155. def dreturn(pc: PC, value: DomainValue): Computation[Nothing, 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
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  156. def dsub(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  159. def evaluationCompleted(pc: PC, worklist: Chain[PC], evaluated: Chain[PC], operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): Unit

    Permalink

    Called by the framework after evaluating the instruction with the given pc.

    Called by the framework after evaluating the instruction with the given pc. I.e., the state of all potential successor instructions was updated and the flow method was called – potentially multiple times – accordingly.

    By default this method does nothing.

    Definition Classes
    CoreDomainFunctionality
  160. def f2d(pc: PC, value: DomainValue): DomainValue

    Permalink
  161. def f2i(pc: PC, value: DomainValue): DomainValue

    Permalink
  162. def f2l(pc: PC, value: DomainValue): DomainValue

    Permalink
  163. def fadd(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  164. def faload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  165. def fastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  166. def fcmpg(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  167. def fcmpl(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  168. def fdiv(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  169. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  170. def flow(currentPC: PC, currentOperands: Operands, currentLocals: Locals, successorPC: PC, isSuccessorScheduled: Answer, isExceptionalControlFlow: Boolean, abruptSubroutineTerminationCount: Int, wasJoinPerformed: Boolean, worklist: Chain[PC], operandsArray: OperandsArray, localsArray: LocalsArray, tracer: Option[AITracer]): Chain[PC]

    Permalink

    Called by the framework after performing a computation to inform the domain about the result.

    Called by the framework after performing a computation to inform the domain about the result. That is, after evaluating the effect of the instruction with currentPC on the current stack and register and (if necessary) joining the updated stack and registers with the stack and registers associated with the instruction successorPC. (Hence, this method is ONLY called for return instructions if the return instruction throws an IllegalMonitorStateException.) This function basically informs the domain about the instruction that may be evaluated next. The flow function is called for every possible successor of the instruction with currentPC. This includes all branch targets as well as those instructions that handle exceptions.

    In some cases it will even be the case that flow is called multiple times with the same pair of program counters: (currentPC, successorPC). This may happen, e.g., in case of a switch instruction where multiple values have the same body/target instruction and we do not have precise information about the switch value. E.g., as in the following snippet:

    switch (i) {  // pc: X => Y (for "1"), Y (for "2"), Y (for "3")
    case 1:
    case 2:
    case 3: System.out.println("Great.");            // pc: Y
    default: System.out.println("Not So Great.");    // pc: Z
    }

    The flow function is also called after instructions that are domain independent such as dup and load instructions which just manipulate the registers and stack in a generic way. This enables the domain to precisely follow the evaluation progress and in particular to perform control-flow dependent analyses.

    currentPC

    The program counter of the instruction that is currently evaluated by the abstract interpreter.

    currentOperands

    The current operands. I.e., the operand stack before the instruction is evaluated.

    currentLocals

    The current locals. I.e., the locals before the instruction is evaluated.

    successorPC

    The program counter of an instruction that is a potential successor of the instruction with currentPC. In general the AI framework adds the pc of the successor instruction to the beginning of the worklist unless it is a join instruction. In this case the pc is added to the end – in the context of the current (sub)routine. Hence, the AI framework first evaluates all paths leading to a join instruction before the join instruction will be evaluated.

    isSuccessorScheduled

    Yes if the successor instruction is or was scheduled. I.e., Yes is returned if the worklist contains successorPC, No if the worklist does not contain successorPC. Unknown is returned if the AI framework did not process the worklist and doesn't know anything about the scheduled successors. Note that this value is independent of the subroutine in which the value may be scheduled. If an implementation schedules successorPC the the super call has to set isSuccessorScheduled to Yes.

    isExceptionalControlFlow

    true if and only if the evaluation of the instruction with the program counter currentPC threw an exception; false otherwise. Hence, if this parameter is true the instruction with successorPC is the first instruction of the handler.

    abruptSubroutineTerminationCount

    > 0 if and only if we have an exceptional control flow that terminates one or more subroutines. In this case the successor instruction is scheduled (if at all) after all subroutines that will be terminated by the exception.

    wasJoinPerformed

    true if a join was performed. I.e., the successor instruction is an instruction (Code.cfJoins) that was already previously evaluated and where multiple paths potentially join.

    worklist

    The current list of instructions that will be evaluated next.

    If subroutines are not used (i.e., Java >= 5)

    If you want to force the evaluation of the instruction with the program counter successorPC it is sufficient to test whether the list already contains successorPC and – if not – to prepend it. If the worklist already contains successorPC then the domain is allowed to move the PC to the beginning of the worklist.

    If the code contains subroutines (JSR/RET)

    If the PC does not belong to the same (current) (sub)routine, it is not allowed to be moved to the beginning of the worklist. (Subroutines can only be found in code generated by old Java compilers; before Java 6. Subroutines are identified by jsr/ret instructions. A subroutine can be identified by going back in the worklist and by looking for specific "program counters" (e.g., SUBROUTINE_START, SUBROUTINE_END). These program counters mark the beginning of a subroutine. In other words, an instruction can be freely moved around unless a special program counter value is found. All special program counters use negative values. Additionally, neither the negative values nor the positive values between two negative values should be changed. Furthermore, no value (PC) should be put between negative values that capture subroutine information. If the domain updates the worklist, it is the responsibility of the domain to call the tracer and to inform it about the changes. Note that the worklist is not allowed to contain duplicates related to the evaluation of the current (sub-)routine.

    operandsArray

    The array that associates every instruction with its operand stack that is in effect. Note, that only those elements of the array contain values that are related to instructions that were evaluated in the past; the other elements are null. Furthermore, it identifies the operandsArray of the subroutine that will execute the instruction with successorPC. The operandsArray may be null for the current instruction (not the successor instruction) if the execution of the current instruction leads to the termination of the current subroutine. In this case the information about the operands and locals associated with all instructions belonging to the subroutine is reset.

    localsArray

    The array that associates every instruction with its current register values. Note, that only those elements of the array contain values that are related to instructions that were evaluated in the past. The other elements are null. Furthermore, it identifies the localsArray of the subroutine that will execute the instruction with successorPC. The localsArray may be null for the current instruction (not the successor instruction) if the execution of the current instruction leads to the termination of the current subroutine. In this case the information about the operands and locals associated with all instructions belonging to the subroutine is reset.

    returns

    The updated worklist. In most cases this is simply the given worklist. The default case is also to return the given worklist.

    Definition Classes
    CoreDomainFunctionality
    Note

    A method that overrides this method must always call the super method to ensure that every domain that uses this hook gets informed about a flow.

    ,

    The domain is allowed to modify the worklist, operandsArray and localsArray. However, the AI will not perform any checks. In case of updates of the operandsArray or localsArray it is necessary to first create a shallow copy before updating it. If this is not done, it may happen that the locals associated with other instructions are also updated.

  171. def fmul(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  172. def fneg(pc: PC, value: DomainValue): DomainValue

    Permalink
  173. def foreachOrigin(value: DomainValue, f: (ValueOrigin) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Origin
  174. def frem(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  175. def freturn(pc: PC, value: DomainValue): Computation[Nothing, 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
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  176. def fsub(pc: PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
  177. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  178. def getPotentialExceptions(pc: PC): List[ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  179. def getfield(pc: PC, objectref: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[DomainValue, ExceptionValue]

    Permalink

    Returns the field's value and/or a new NullPointerException if the given objectref represents the value null.

    Returns the field's value and/or a new NullPointerException if the given objectref represents the value null.

    returns

    The field's value or a new NullPointerException.

    Definition Classes
    TypeLevelFieldAccessInstructionsFieldAccessesDomain
  180. def getstatic(pc: PC, declaringClass: ObjectType, name: String, fieldType: FieldType): Computation[DomainValue, Nothing]

    Permalink

    Returns the field's value.

    Returns the field's value.

    Definition Classes
    ClassValuesFieldAccessesDomain
  181. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, targetMethods: Set[Method], receiverIsNull: Answer, operands: Operands): MethodCallResult

    Permalink

    methodDescriptor

    The method descriptor as specified by the invoke instruction. In case of the invocation of a signature polymorphic method using org.opalj.br.instructions.INVOKEVIRTUAL the descriptor of the invoked method may differ from the descriptor used by the method. Nevertheless, the MethodCallResult has to satisfy the requirements of the caller. In particular regarding the return type.

    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  182. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  183. def handleInstanceBasedInvoke(pc: PC, methodDescriptor: MethodDescriptor, receiverIsNull: Answer): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  184. def handleInvoke(pc: PC, targetMethod: Method, operands: Operands): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  185. def handleInvoke(pc: PC, methodDescriptor: MethodDescriptor): MethodCallResult

    Permalink
    Attributes
    protected[this]
    Definition Classes
    MethodCallsHandling
  186. def handleReturn(pc: PC): Computation[Nothing, ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ReturnInstructionsDomain
  187. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  188. def i2b(pc: br.PC, value: DomainValue): DomainTypedValue[CTIntType]

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  189. def i2c(pc: br.PC, value: DomainValue): DomainTypedValue[CTIntType]

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  190. def i2d(pc: PC, value: DomainValue): DomainValue

    Permalink
  191. def i2f(pc: PC, value: DomainValue): DomainValue

    Permalink
  192. def i2l(pc: PC, value: DomainValue): DomainValue

    Permalink
  193. def i2s(pc: br.PC, value: DomainValue): DomainTypedValue[CTIntType]

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  194. def iadd(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  195. def iaload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  196. def iand(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  197. def iastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  198. def idiv(pc: br.PC, numerator: DomainValue, denominator: DomainValue): IntegerValueOrArithmeticException

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  199. def iinc(pc: br.PC, value: DomainValue, increment: Int): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  200. def imul(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  201. def ineg(pc: br.PC, value: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  202. def intAreEqual(pc: br.PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Tests if the two given integer values are equal.

    Tests if the two given integer values are equal.

    value1

    A value with computational type integer.

    value2

    A value with computational type integer.

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  203. def intAreNotEqual(pc: PC, value1: DomainValue, value2: DomainValue): Answer

    Permalink

    Tests if the two given integer values are not equal.

    Tests if the two given integer values are not equal.

    value1

    A value with computational type integer.

    value2

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  204. def intEstablishAreEqual(pc: br.PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 == value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  205. def intEstablishAreNotEqual(pc: br.PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 != value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  206. def intEstablishIsLessThan(pc: br.PC, left: DomainValue, right: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 < value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  207. def intEstablishIsLessThanOrEqualTo(pc: br.PC, left: DomainValue, right: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
    Note

    This function is ONLY defined if a corresponding test (value1 <= value2) returned org.opalj.Unknown. I.e., this method is only allowed to be called if there is something to establish! I.e., the domain values are real ranges (not single values, e.g., [1,1]) that overlap.

  208. def intEstablishValue(pc: br.PC, theValue: Int, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Sets the given domain value to theValue.

    Sets the given domain value to theValue.

    This function is called by OPAL before it starts to explore the branch where this condition has to hold. (This function is, e.g., called whenever we explore the branches of a switch-case statement.) I.e., the constraint is established before a potential join operation.

    value

    An integer domain value that does also, but not exclusively represents theValue.

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  209. def intIs0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is 0 or maybe 0.

    Tests if the given integer value is 0 or maybe 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  210. def intIsGreaterThan(pc: PC, largerValue: DomainValue, smallerValue: DomainValue): Answer

    Permalink

    Tests if the first integer value is larger than the second value.

    Tests if the first integer value is larger than the second value.

    largerValue

    A value with computational type integer.

    smallerValue

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  211. def intIsGreaterThan0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is > 0 or maybe > 0.

    Tests if the given integer value is > 0 or maybe > 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  212. def intIsGreaterThanOrEqualTo(pc: PC, largerOrEqualValue: DomainValue, smallerOrEqualValue: DomainValue): Answer

    Permalink

    Tests if the first integer value is larger than or equal to the second value.

    Tests if the first integer value is larger than or equal to the second value.

    largerOrEqualValue

    A value with computational type integer.

    smallerOrEqualValue

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  213. def intIsGreaterThanOrEqualTo0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given value is greater than or equal to 0 or maybe greater than or equal to 0.

    Tests if the given value is greater than or equal to 0 or maybe greater than or equal to 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  214. def intIsLessThan(pc: br.PC, left: DomainValue, right: DomainValue): Answer

    Permalink

    Tests if the first integer value is smaller than the second value.

    Tests if the first integer value is smaller than the second value.

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  215. def intIsLessThan0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is < 0 or maybe < 0.

    Tests if the given integer value is < 0 or maybe < 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  216. def intIsLessThanOrEqualTo(pc: br.PC, left: DomainValue, right: DomainValue): Answer

    Permalink

    Tests if the first integer value is less than or equal to the second value.

    Tests if the first integer value is less than or equal to the second value.

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  217. def intIsLessThanOrEqualTo0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is less than or equal to 0 or maybe less than or equal to 0.

    Tests if the given integer value is less than or equal to 0 or maybe less than or equal to 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  218. def intIsNot0(pc: PC, value: DomainValue): Answer

    Permalink

    Tests if the given integer value is not 0 or maybe not 0.

    Tests if the given integer value is not 0 or maybe not 0.

    value

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  219. def intIsSomeValueInRange(pc: br.PC, value: DomainValue, lowerBound: Int, upperBound: Int): Answer

    Permalink

    Returns Yes iff at least one possible extension of the given value is in the specified range; that is, if the intersection of the range of values captured by the given value and the specified range is non-empty.

    Returns Yes iff at least one possible extension of the given value is in the specified range; that is, if the intersection of the range of values captured by the given value and the specified range is non-empty.

    For example, if the given value captures all positive integer values and the specified range is [-1,1] then the answer has to be Yes. If we know nothing about the potential extension of the given value the answer will be Unknown. The answer is No iff both ranges are non-overlapping.

    value

    A value that has to be of computational type integer.

    lowerBound

    The range's lower bound (inclusive).

    upperBound

    The range's upper bound (inclusive).

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  220. def intIsSomeValueNotInRange(pc: br.PC, value: DomainValue, lowerBound: Int, upperBound: Int): Answer

    Permalink

    Returns Yes iff at least one (possible) extension of a given value is not in the specified range; that is, if the set difference of the range of values captured by the given value and the specified range is non-empty.

    Returns Yes iff at least one (possible) extension of a given value is not in the specified range; that is, if the set difference of the range of values captured by the given value and the specified range is non-empty. For example, if the given value has the integer value 10 and the specified range is [0,Integer.MAX_VALUE] then the answer has to be No. But, if the given value represents the range [-5,Integer.MAX_VALUE] and the specified range is again [0,Integer.MAX_VALUE] then the answer has to be Yes.

    The answer is Yes iff the analysis determined that at runtime value will have a value that is not in the specified range. If the analysis(domain) is not able to determine whether the value is or is not in the given range then the answer has to be Unknown.

    value

    A value that has to be of computational type integer.

    lowerBound

    The range's lower bound (inclusive).

    upperBound

    The range's upper bound (inclusive).

    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  221. final def intValue[T](value: DomainValue)(f: (Int) ⇒ T)(orElse: ⇒ T): T

    Permalink

    If the given value encapsulates a precise integer value then the function ifThen is called with the respective value otherwise orElse is called.

    If the given value encapsulates a precise integer value then the function ifThen is called with the respective value otherwise orElse is called.

    Definition Classes
    IntegerSetValuesConcreteIntegerValues
    Annotations
    @inline()
  222. final def intValueOption(value: DomainValue): Option[Int]

    Permalink

    Returns the current Int value represented by the domain value if it exists.

    Returns the current Int value represented by the domain value if it exists.

    Definition Classes
    IntegerSetValuesConcreteIntegerValues
    Annotations
    @inline()
    Note

    This method returns None if the DomainValue does not represent an Integer value or the precise value is not known. I.e., this method never fails.

  223. final def intValues[T](value1: DomainValue, value2: DomainValue)(f: (Int, Int) ⇒ T)(orElse: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    IntegerSetValues
    Annotations
    @inline()
  224. def invokedynamic(pc: PC, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  225. def invokeinterface(pc: PC, declaringClass: ObjectType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  226. def invokespecial(pc: PC, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
    Definition Classes
    StringValuesMethodCallsDomain
  227. def invokestatic(pc: PC, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
    Definition Classes
    ClassValuesMethodCallsDomain
  228. def invokevirtual(pc: PC, declaringClass: ReferenceType, name: String, methodDescriptor: MethodDescriptor, operands: Operands): MethodCallResult

    Permalink
  229. def ior(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  230. def irem(pc: br.PC, left: DomainValue, right: DomainValue): IntegerValueOrArithmeticException

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  231. def ireturn(pc: PC, value: DomainValue): Computation[Nothing, 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
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  232. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  233. def isNull(values: Iterable[AReferenceValue]): Answer

    Permalink

    Determines the common null-ness property of the given reference values.

    Determines the common null-ness property of the given reference values.

    Attributes
    protected
    Definition Classes
    ReferenceValues
  234. def isPrecise(values: Iterable[AReferenceValue]): Boolean

    Permalink

    Determines if the runtime object type referred to by the given values is always the same.

    Determines if the runtime object type referred to by the given values is always the same. I.e., it determines if all values are precise and have the same upperTypeBound. Null values are ignored when determining the precision.

    Attributes
    protected
    Definition Classes
    ReferenceValues
  235. def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Permalink

    Definition Classes
    TheClassHierarchy
    See also

    Delegates to org.opalj.br.ClassHierarchy's isSubtypeOf method.

    Domain.isSubtypeOf

  236. final def isValueSubtypeOf(value: 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.

  237. def ishl(pc: br.PC, value: DomainValue, shift: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  238. def ishr(pc: br.PC, value: DomainValue, shift: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  239. def isub(pc: br.PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  240. def iushr(pc: br.PC, value: DomainValue, shift: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  241. def ixor(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink
    Definition Classes
    IntegerSetValuesIntegerValuesDomain
  242. def join(pc: PC, thisOperands: Operands, thisLocals: Locals, otherOperands: Operands, otherLocals: Locals): Update[(Operands, Locals)]

    Permalink

    Joins the given operand stacks and local variables.

    Joins the given operand stacks and local variables.

    In general there should be no need to refine this method. Overriding this method should only be done for analysis purposes.

    Performance

    This method heavily relies on reference comparisons to speed up the overall process of performing an abstract interpretation of a method. Hence, a computation should – whenever possible – return (one of) the original object(s) if that value has the same abstract state as the result. Furthermore, if all original values capture the same abstract state as the result of the computation, the "left" value/the value that was already used in the past should be returned.

    returns

    The joined operand stack and registers. Returns NoUpdate if this memory layout already subsumes the other memory layout.

    Definition Classes
    CoreDomainFunctionality
    Note

    The operand stacks are guaranteed to contain compatible values w.r.t. the computational type (unless the bytecode is not valid or OPAL contains an error). I.e., if the result of joining two operand stack values is an IllegalValue we assume that the domain implementation is incorrect. However, the joining of two register values can result in an illegal value - which identifies the value as being dead.

    ,

    The size of the operands stacks that are to be joined and the number of registers/locals that are to be joined can be expected to be identical under the assumption that the bytecode is valid and the framework contains no bugs.

  243. def joinPostProcessing(updateType: UpdateType, pc: PC, oldOperands: Operands, oldLocals: Locals, newOperands: Operands, newLocals: Locals): Update[(Operands, Locals)]

    Permalink

    Enables the customization of the behavior of the base join method.

    Enables the customization of the behavior of the base join method.

    This method in particular enables, in case of a MetaInformationUpdate, to raise the update type to force the continuation of the abstract interpretation process.

    Methods should always override this method and should call the super method.

    updateType

    The current update type. The level can be raised. It is an error to lower the update level.

    oldOperands

    The old operands, before the join. Should not be changed.

    oldLocals

    The old locals, before the join. Should not be changed.

    newOperands

    The new operands; may be updated.

    newLocals

    The new locals; may be updated.

    Attributes
    protected[this]
    Definition Classes
    IdentityBasedCorrelationChangeDetectionCoreDomainFunctionality
  244. def joinValues(pc: PC, left: DomainValue, right: DomainValue): Update[DomainValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    JoinStabilizationCoreDomainFunctionality
  245. val joinedValues: Map[IdentityPair[AnyRef, AnyRef], Update[DomainValue]]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    JoinStabilization
  246. def jumpToSubroutine(pc: PC, branchTarget: PC, returnTarget: PC): Unit

    Permalink

    pc

    The pc of the jsr(w) instruction.

    Definition Classes
    SubroutinesDomain
  247. final def justThrows(value: ExceptionValue): ThrowsException[ExceptionValues]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  248. def l2d(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to a double value.

    Conversion of the given long value to a double value.

    returns

    The result of calling DoubleValue(pc).

    Definition Classes
    ConcretePrimitiveValuesConversionsTypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  249. def l2f(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to a float value.

    Conversion of the given long value to a float value.

    returns

    The result of calling FloatValue(pc).

    Definition Classes
    ConcretePrimitiveValuesConversionsTypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  250. def l2i(pc: PC, value: DomainValue): DomainValue

    Permalink

    Conversion of the given long value to an integer value.

    Conversion of the given long value to an integer value.

    returns

    The result of calling IntegerValue(pc).

    Definition Classes
    ConcretePrimitiveValuesConversionsTypeLevelPrimitiveValuesConversionsPrimitiveValuesConversionsDomain
  251. def ladd(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Add of two long values.

    Add of two long values.

    pc

    The pc of the add(+) instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).

    Definition Classes
    LongSetValuesLongValuesDomain
  252. def laload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  253. def land(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Boolean and of two long values.

    Boolean and of two long values.

    pc

    The pc of the "&" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).

    Definition Classes
    LongSetValuesLongValuesDomain
  254. def lastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  255. def lcmp(pc: br.PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink

    Comparison (==) of two long values.

    Comparison (==) of two long values.

    pc

    The pc of the comparison instruction.

    returns

    A domain value that encapsulates an integer value with the value -1,0 or 1.

    Definition Classes
    LongSetValuesLongValuesDomain
  256. def ldiv(pc: br.PC, numerator: DomainValue, denominator: DomainValue): LongValueOrArithmeticException

    Permalink

    Division of two long values.

    Division of two long values.

    pc

    The pc of the div (/) instruction.

    returns

    The return value is the calculated value and/or (depending on the domain) an ArithmeticException if value2 is 0.

    Definition Classes
    LongSetValuesLongValuesDomain
  257. def lmul(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Multiplication of two long values.

    Multiplication of two long values.

    pc

    The pc of the mul (/) instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).

    Definition Classes
    LongSetValuesLongValuesDomain
  258. def lneg(pc: br.PC, value: DomainValue): DomainValue

    Permalink

    Negation of a long value.

    Negation of a long value.

    pc

    The pc of the neg instruction.

    value

    A long value (guaranteed by the JVM's semantics).

    Definition Classes
    LongSetValuesLongValuesDomain
  259. implicit final def logContext: LogContext

    Permalink
    Definition Classes
    TheProjectLogContextProvider
  260. final def longValue[T](value: DomainValue)(f: (Long) ⇒ T)(orElse: ⇒ T): T

    Permalink

    If the given value represents one specific long value then the function ifThen is called with the respective value otherwise orElse is called.

    If the given value represents one specific long value then the function ifThen is called with the respective value otherwise orElse is called.

    Definition Classes
    LongSetValuesConcreteLongValues
    Annotations
    @inline()
  261. final def longValueOption(value: DomainValue): Option[Long]

    Permalink

    Returns the current Long value represented by the domain value if it exists.

    Returns the current Long value represented by the domain value if it exists.

    Definition Classes
    LongSetValuesConcreteLongValues
    Annotations
    @inline()
    Note

    This method returns None if the DomainValue does not represent a Long value or the precise value is not known. I.e., this method never fails.

  262. def lor(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    Boolean or of two long values.

    Boolean or of two long values.

    pc

    The pc of the "boolean or" (|) instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).

    Definition Classes
    LongSetValuesLongValuesDomain
  263. def lrem(pc: br.PC, left: DomainValue, right: DomainValue): LongValueOrArithmeticException

    Permalink

    Remainder of two long values.

    Remainder of two long values.

    pc

    The pc of the div (/) instruction.

    returns

    The return value is the calculated value and/or (depending on the domain) an ArithmeticException if value2 is 0.

    Definition Classes
    LongSetValuesLongValuesDomain
  264. def lreturn(pc: PC, value: DomainValue): Computation[Nothing, 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
    DefaultHandlingForReturnInstructionsReturnInstructionsDomain
  265. def lshl(pc: PC, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]

    Permalink

    Shift left of a long value.

    Shift left of a long value.

    pc

    The pc of the "shift left" instruction.

    Definition Classes
    LongValuesShiftOperatorsLongValuesDomain
  266. def lshr(pc: PC, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]

    Permalink

    Shift right of a long value.

    Shift right of a long value.

    pc

    The pc of the "shift right" instruction.

    Definition Classes
    LongValuesShiftOperatorsLongValuesDomain
  267. def lsub(pc: br.PC, left: DomainValue, right: DomainValue): DomainValue

    Permalink

    Subtraction of two long values.

    Subtraction of two long values.

    pc

    The pc of the sub(-) instruction.

    Definition Classes
    LongSetValuesLongValuesDomain
  268. def lushr(pc: PC, longValue: DomainValue, shiftValue: DomainValue): DomainTypedValue[LongType]

    Permalink

    Unsigned shift right of a long value.

    Unsigned shift right of a long value.

    pc

    The pc of the "unsigned shift right" instruction.

    Definition Classes
    LongValuesShiftOperatorsLongValuesDomain
  269. def lxor(pc: br.PC, value1: DomainValue, value2: DomainValue): DomainValue

    Permalink

    xor of two long values.

    xor of two long values.

    pc

    The pc of the "xor" instruction.

    value1

    A long value (guaranteed by the JVM's semantics).

    value2

    A long value (guaranteed by the JVM's semantics).

    Definition Classes
    LongSetValuesLongValuesDomain
  270. def maxCardinalityOfIntegerSets: Int

    Permalink

    Determines the maximum size of values captured by an Integer set.

    Determines the maximum size of values captured by an Integer set.

    In many cases a rather (4-16) small number is completely sufficient to capture typical variability.

    The minimum value is 1; however 2 is the meaningful minimum value.

    Definition Classes
    IntegerSetValues
  271. def maxCardinalityOfLongSets: Int

    Permalink

    Determines the maximum number of values captured by a set of Long values.

    Determines the maximum number of values captured by a set of Long values.

    Often, a very small cardinality (e.g., 2 or 8) may be completely sufficient and a large cardinality does not significantly add to the overall precision.

    Attributes
    protected
    Definition Classes
    LongSetValues
  272. def mergeDEComputations(pc: PC, c1: Computation[DomainValue, ExceptionValue], c2: Computation[DomainValue, ExceptionValue]): Computation[DomainValue, 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
  273. def mergeDEsComputations(pc: PC, c1: Computation[DomainValue, ExceptionValues], c2: Computation[DomainValue, ExceptionValues]): Computation[DomainValue, 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
  274. def mergeDomainValues(pc: PC, v1: DomainValue, v2: DomainValue): 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
  275. def mergeEsComputations(pc: PC, c1: Computation[Nothing, ExceptionValues], c2: Computation[Nothing, ExceptionValues]): Computation[Nothing, 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
  276. def mergeMultipleExceptionValues(pc: PC, v1s: ExceptionValues, v2s: ExceptionValues): 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
  277. val method: Method

    Permalink

    Returns the method that is currently analyzed.

    Returns the method that is currently analyzed.

    Definition Classes
    DefaultSetValuesDomainTheMethod
  278. def monitorenter(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink

    Handles a monitorenter instruction.

    Handles a monitorenter instruction.

    Definition Classes
    IgnoreSynchronizationMonitorInstructionsDomain
    Note

    The default implementation checks if the given value is null and raises an exception if it is null or maybe null.

  279. def monitorexit(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValues]

    Permalink

    Handles a monitorexit instruction.

    Handles a monitorexit instruction.

    Definition Classes
    IgnoreSynchronizationMonitorInstructionsDomain
    Note

    The default implementation checks if the given value is null and raises an exception if it is null or maybe null.

  280. def multianewarray(pc: PC, counts: Operands, arrayType: ArrayType): Computation[DomainArrayValue, 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.

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

    Permalink
    Definition Classes
    AnyRef
  282. def newarray(pc: PC, count: DomainValue, componentType: FieldType): Computation[DomainValue, 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.

  283. def nextT(): Timestamp

    Permalink

    Returns the next unused time stamp.

    Returns the next unused time stamp.

    Definition Classes
    ReferenceValues
  284. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  286. final def nullT: Timestamp

    Permalink
    Definition Classes
    ReferenceValues
  287. def origin(value: DomainValue): Iterable[ValueOrigin]

    Permalink

    Returns the origin(s) of the given value if the information is available.

    Returns the origin(s) of the given value if the information is available.

    returns

    The source(s) of the given value if the information is available. Whether the information is available depends on the concrete domains. This trait only defines a general contract how to get access to a value's origin (I.e., the origin of the instruction which created the respective value.) By default this method returns an empty Iterable.

    Definition Classes
    Origin
  288. val project: Project[Source]

    Permalink

    Returns the project that is currently analyzed.

    Returns the project that is currently analyzed.

    Definition Classes
    DefaultSetValuesDomainTheProject
  289. 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
  290. final lazy val propertyStore: PropertyStore

    Permalink
    Definition Classes
    TheProjectThePropertyStore
  291. def putfield(pc: PC, objectref: DomainValue, value: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[Nothing, ExceptionValue]

    Permalink

    Sets the field's value if the given objectref is not null(in the Domain).

    Sets the field's value if the given objectref is not null(in the Domain). In the latter case a NullPointerException is thrown.

    Definition Classes
    TypeLevelFieldAccessInstructionsFieldAccessesDomain
  292. def putstatic(pc: PC, value: DomainValue, declaringClass: ObjectType, fieldName: String, fieldType: FieldType): Computation[Nothing, Nothing]

    Permalink

    Sets the field's value.

    Sets the field's value.

    Definition Classes
    TypeLevelFieldAccessInstructionsFieldAccessesDomain
  293. def refAreEqual(pc: PC, v1: DomainValue, v2: DomainValue): Answer

    Permalink

    Returns Yes if both DomainReferenceValues definitively identify the same object at runtime.

    Returns Yes if both DomainReferenceValues definitively identify the same object at runtime.

    Using this domain, it is in general not possible to determine that two values are definitively not reference equal unless they are type incompatible.

    Definition Classes
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesDomain
  294. def refAreNotEqual(pc: PC, value1: DomainValue, value2: 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
  295. def refEstablishAreEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, 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
  296. def refEstablishAreNotEqual(pc: PC, value1: DomainValue, value2: DomainValue, operands: Operands, locals: Locals): (Operands, 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
  297. def refEstablishIsNonNull(pc: PC, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Refines the "null"ness property (isNull == No) of the given value.

    Refines the "null"ness property (isNull == No) of the given value.

    Calls refineIsNull on the given ReferenceValue and replaces every occurrence on the stack/in a register with the updated value.

    value

    A ReferenceValue that does not represent the value null.

    Definition Classes
    ReferenceValuesReferenceValuesDomain
  298. def refEstablishIsNull(pc: PC, value: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Updates the "null"ness property (isNull == Yes) of the given value.

    Updates the "null"ness property (isNull == Yes) of the given value.

    Calls refineIsNull on the given ReferenceValue and replaces every occurrence on the stack/in a register with the updated value.

    value

    A ReferenceValue.

    Definition Classes
    ReferenceValuesReferenceValuesDomain
  299. def refIsNonNull(pc: PC, value: 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
  300. final def refIsNull(pc: PC, value: 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
  301. def refSetUpperTypeBoundOfTopOperand(pc: PC, bound: ReferenceType, operands: Operands, locals: Locals): (Operands, 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
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesDomain
  302. def refTopOperandIsNull(pc: PC, operands: Operands, locals: Locals): (Operands, 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
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesDomain
  303. def refineIsNull(pc: PC, value: DomainValue, isNull: Answer, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ReferenceValues
  304. def returnFromSubroutine(pc: PC, lvIndex: Int): Unit

    Permalink

    pc

    The pc of the ret instruction.

    Definition Classes
    SubroutinesDomain
  305. def returnVoid(pc: PC): Computation[Nothing, 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
    DefaultHandlingOfVoidReturnsReturnInstructionsDomain
  306. def saload(pc: PC, index: DomainValue, arrayref: DomainValue): ArrayLoadResult

    Permalink
  307. def sastore(pc: PC, value: DomainValue, index: DomainValue, arrayref: DomainValue): ArrayStoreResult

    Permalink
  308. def schedule(successorPC: PC, abruptSubroutineTerminationCount: Int, worklist: Chain[PC]): Chain[PC]

    Permalink

    This function can be called when the instruction successorPC needs to be scheduled.

    This function can be called when the instruction successorPC needs to be scheduled. The function will test if the instruction is already scheduled and – if so – returns the given worklist. Otherwise the instruction is scheduled in the correct (subroutine-)context.

    Attributes
    protected[this]
    Definition Classes
    CoreDomainFunctionality
  309. def sideEffectOnlyOrExceptions(pc: PC, value: DomainValue): Computation[Nothing, ExceptionValue]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    IgnoreSynchronization
  310. def simpleClassForNameCall(pc: PC, className: String): MethodCallResult

    Permalink
    Attributes
    protected[org.opalj.ai.domain.l1]
    Definition Classes
    ClassValues
  311. def summarize(pc: PC, values: Iterable[DomainValue]): 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.

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

    Permalink
    Definition Classes
    AnyRef
  313. def throwArithmeticExceptions: Boolean

    Permalink

    If true, all instructions that may raise an arithmetic exception (e.g., idiv, ldiv) should do so if it is impossible to statically determine that no exception will occur.

    If true, all instructions that may raise an arithmetic exception (e.g., idiv, ldiv) should do so if it is impossible to statically determine that no exception will occur. But, if we can statically determine that the operation will raise an exception then the exception will be thrown – independently of this setting. Furthermore, if we can statically determine that no exception will be raised, no exception will be thrown. Hence, this setting only affects computations with values with incomplete information.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  314. def throwArrayIndexOutOfBoundsException: Boolean

    Permalink

    If true an ArrayIndexOutOfBoundsException is thrown if the index cannot be verified to be valid.

    If true an ArrayIndexOutOfBoundsException is thrown if the index cannot be verified to be valid.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  315. def throwArrayStoreException: Boolean

    Permalink

    If true an ArrayStoreException is thrown if it cannot be verified that the value can be stored in the array.

    If true an ArrayStoreException is thrown if it cannot be verified that the value can be stored in the array.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  316. def throwClassCastException: Boolean

    Permalink

    If true a ClassCastException is thrown by CHECKCAST instructions if it cannot be verified that no ClassCastException will be thrown.

    If true a ClassCastException is thrown by CHECKCAST instructions if it cannot be verified that no ClassCastException will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  317. def throwClassNotFoundException: Boolean

    Permalink

    Throw a ClassNotFoundException if the a specific reference type is not known in the current context.

    Throw a ClassNotFoundException if the a specific reference type is not known in the current context. The context is typically a specific Project.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  318. def throwExceptionsOnMethodCall: ExceptionsRaisedByCalledMethod

    Permalink

    Determines the behavior how method calls are handled where the exceptions that the called method may throw are unknown.

    Determines the behavior how method calls are handled where the exceptions that the called method may throw are unknown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  319. def throwIllegalMonitorStateException: Boolean

    Permalink

    If true then monitorexit and the (XXX)return instructions will throw IllegalMonitorStateExceptions unless the analysis is able to determine that the exception is guaranteed to be raised.

    If true then monitorexit and the (XXX)return instructions will throw IllegalMonitorStateExceptions unless the analysis is able to determine that the exception is guaranteed to be raised.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  320. def throwNegativeArraySizeException: Boolean

    Permalink

    If true a NegativeArraySizeException is thrown if the index cannot be verified to be positive.

    If true a NegativeArraySizeException is thrown if the index cannot be verified to be positive.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  321. def throwNullPointerExceptionOnArrayAccess: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  322. def throwNullPointerExceptionOnFieldAccess: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  323. def throwNullPointerExceptionOnMethodCall: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown. Example:

    def demo(o : Object) {
         o.toString  // - If "true", a NullPointerException will ALSO be thrown;
                     //   the operation also succeeds.
                     // - If "false" the operation will "just" succeed
    }
    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  324. def throwNullPointerExceptionOnMonitorAccess: Boolean

    Permalink

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored.

    Returns true if potential NullPointerExceptions should be thrown and false if such NullPointerExceptions should be ignored. However, if the interpreter identifies a situation in which a NullPointerException is guaranteed to be thrown, it will be thrown.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  325. def throwNullPointerExceptionOnThrow: Boolean

    Permalink

    If true a NullPointerExceptions is thrown if the exception that is to be thrown is not not known to be null.

    If true a NullPointerExceptions is thrown if the exception that is to be thrown is not not known to be null.

    returns

    true

    Definition Classes
    ThrowAllPotentialExceptionsConfigurationConfiguration
  326. final def throws(value: ExceptionValue): ThrowsException[ExceptionValue]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  327. def toDomainValue(pc: PC, value: AnyRef): DomainReferenceValue

    Permalink

    Converts the given Java object to a corresponding DomainValue.

    Converts the given Java object to a corresponding DomainValue. By creating an DomainValue that represents an initialized (array/object) value.

    pc

    The program counter of the instruction that was responsible for creating the respective value. (This is in – in general – not the instruction where the transformation is performed.)

    value

    The object.

    returns

    A DomainReferenceValue.

    Definition Classes
    StringValuesDefaultJavaObjectToDomainValueConversionAsDomainValue
  328. def toJavaObject(pc: PC, value: 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
    StringValuesReferenceValuesTypeLevelReferenceValuesAsJavaObject
    Note

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

  329. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  330. def typeOfValue(value: 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
  331. def updateAfterEvaluation(oldValue: DomainValue, newValue: DomainValue): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  332. def updateAfterException(oldValue: DomainValue, newValue: DomainValue): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  333. def updateAfterExecution(oldValue: DomainValue, newValueAfterEvaluation: DomainValue, newValueAfterException: DomainValue): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  334. def updateMemoryLayout(oldValue: DomainValue, newValue: DomainValue, operands: Operands, locals: Locals): (Operands, Locals)

    Permalink

    Replaces all occurrences of oldValue (using reference-quality) with newValue.

    Replaces all occurrences of oldValue (using reference-quality) with newValue. If no occurrences are found, the original operands and locals data structures are returned.

    Definition Classes
    CoreDomainFunctionality
  335. def upperTypeBound(theValues: UIDSet[DomainSingleOriginReferenceValue]): UIDSet[_ <: ReferenceType]

    Permalink

    Calculates the most specific common upper type bound of the upper type bounds of all values.

    Calculates the most specific common upper type bound of the upper type bounds of all values. NullValues are ignored.

    Definition Classes
    ReferenceValues
  336. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  339. final def withLongValuesOrElse[T](value1: DomainValue, value2: DomainValue)(f: (Long, Long) ⇒ T)(orElse: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    LongSetValues
    Annotations
    @inline()

Inherited from LongValuesShiftOperators

Inherited from DefaultLongSetValues

Inherited from LongSetValues

Inherited from ConcreteLongValues

Inherited from DefaultIntegerSetValues

Inherited from IntegerSetValues

Inherited from IntegerRangeValuesFactory

Inherited from ConcreteIntegerValues

Inherited from NullPropertyRefinement

Inherited from DefaultClassValuesBinding

Inherited from ClassValues

Inherited from StringValues

Inherited from AsDomainValue

Inherited from DefaultExceptionsFactory

Inherited from ReferenceValues

Inherited from Origin

Inherited from TypeLevelReferenceValues

Inherited from AsJavaObject

Inherited from GeneralizedArrayHandling

Inherited from MethodCallsHandling

Inherited from TypeLevelDoubleValues

Inherited from TypeLevelFloatValues

Inherited from IgnoreSynchronization

Inherited from ReturnInstructionsDomain

Inherited from DefaultDomainValueBinding

Inherited from TheMethod

Inherited from TheCode

Inherited from TheProject

Inherited from ThePropertyStore

Inherited from LogContextProvider

Inherited from TheClassHierarchy

Inherited from CorrelationalDomain

Inherited from JoinStabilization

Inherited from Domain

Inherited from Configuration

Inherited from TypedValuesFactory

Inherited from MonitorInstructionsDomain

Inherited from MethodCallsDomain

Inherited from FieldAccessesDomain

Inherited from ReferenceValuesDomain

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from DoubleValuesDomain

Inherited from DoubleValuesFactory

Inherited from FloatValuesDomain

Inherited from FloatValuesFactory

Inherited from LongValuesDomain

Inherited from LongValuesFactory

Inherited from IntegerValuesDomain

Inherited from IntegerValuesFactory

Inherited from CoreDomainFunctionality

Inherited from SubroutinesDomain

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

Ungrouped