Trait

org.opalj.ai.domain

RecordConstraints

Related Doc: package domain

Permalink

trait RecordConstraints extends ReifiedConstraints

Mixin this trait if you want to reify the constraints that are stated by the abstract interpretation framework. This is particularly useful for testing and debugging purposes.

Self Type
RecordConstraints with ValuesDomain
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordConstraints
  2. ReifiedConstraints
  3. ReferenceValuesDomain
  4. ReferenceValuesFactory
  5. ExceptionsFactory
  6. IntegerValuesDomain
  7. IntegerValuesFactory
  8. ValuesDomain
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type ArrayLoadResult = Computation[(RecordConstraints.this)#DomainValue, (RecordConstraints.this)#ExceptionValues]

    Permalink

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

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

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

    Permalink

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

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

    Definition Classes
    ReferenceValuesDomain
  3. abstract type DomainIllegalValue <: (RecordConstraints.this)#IllegalValue with (RecordConstraints.this)#DomainValue

    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
    ValuesDomain
  4. abstract type DomainReferenceValue >: Null <: (RecordConstraints.this)#ReferenceValue with (RecordConstraints.this)#DomainTypedValue[ReferenceType]

    Permalink
    Definition Classes
    ValuesDomain
  5. abstract type DomainReturnAddressValue <: (RecordConstraints.this)#ReturnAddressValue with (RecordConstraints.this)#DomainValue

    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
    ValuesDomain
  6. abstract type DomainReturnAddressValues <: (RecordConstraints.this)#ReturnAddressValues with (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    ValuesDomain
  7. abstract type DomainTypedValue[+T <: Type] >: Null <: (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    ValuesDomain
  8. abstract type DomainValue >: Null <: (RecordConstraints.this)#Value

    Permalink

    Abstracts over the concrete type of Value.

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

    Definition Classes
    ValuesDomain
  9. type ExceptionValue = (RecordConstraints.this)#DomainReferenceValue

    Permalink

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

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

    Definition Classes
    ValuesDomain
  10. type ExceptionValues = Iterable[(RecordConstraints.this)#ExceptionValue]

    Permalink

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

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

    Definition Classes
    ValuesDomain
  11. 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.

  12. type IntegerValueOrArithmeticException = Computation[(RecordConstraints.this)#DomainValue, (RecordConstraints.this)#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
  13. type Locals = collection.mutable.Locals[(RecordConstraints.this)#DomainValue]

    Permalink

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

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

    Definition Classes
    ValuesDomain
  14. type LocalsArray = Array[(RecordConstraints.this)#Locals]

    Permalink
    Definition Classes
    ValuesDomain
  15. type Operands = Chain[(RecordConstraints.this)#DomainValue]

    Permalink

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

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

    Definition Classes
    ValuesDomain
  16. type OperandsArray = Array[(RecordConstraints.this)#Operands]

    Permalink
    Definition Classes
    ValuesDomain
  17. trait RETValue extends Value

    Permalink
    Definition Classes
    ValuesDomain
  18. trait ReferenceValue extends TypedValue[ReferenceType] with IsReferenceValue[DomainReferenceValue]

    Permalink
    Definition Classes
    ValuesDomain
  19. trait ReifiedConstraint extends AnyRef

    Permalink

    Representation of a reified constraint.

    Representation of a reified constraint.

    Definition Classes
    ReifiedConstraints
  20. case class ReifiedSingleValueConstraint(pc: PC, value: (ReifiedConstraints.this)#DomainValue, constraint: String) extends (ReifiedConstraints.this)#ReifiedConstraint with Product with Serializable

    Permalink

    Representation of a constraint related to a single value.

    Representation of a constraint related to a single value.

    Definition Classes
    ReifiedConstraints
  21. case class ReifiedTwoValuesConstraint(pc: PC, value1: (ReifiedConstraints.this)#DomainValue, value2: (ReifiedConstraints.this)#DomainValue, constraint: String) extends (ReifiedConstraints.this)#ReifiedConstraint with Product with Serializable

    Permalink

    Representation of a constraint related to two values.

    Representation of a constraint related to two values.

    Definition Classes
    ReifiedConstraints
  22. 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.

  23. 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
  24. trait TypedValue[+T <: Type] extends Value with KnownType

    Permalink
    Definition Classes
    ValuesDomain
  25. trait Value extends AnyRef

    Permalink

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

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

    Use Of Value/Dependencies On Value

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

    Refining Value

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

    Implementing Value

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

    Definition Classes
    ValuesDomain
    Note

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

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

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

Abstract Value Members

  1. abstract def ArithmeticException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  2. abstract def ArrayIndexOutOfBoundsException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  3. abstract def ArrayStoreException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  4. abstract def BooleanValue(origin: ValueOrigin, value: Boolean): (RecordConstraints.this)#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
    IntegerValuesFactory
  5. abstract def BooleanValue(origin: ValueOrigin): (RecordConstraints.this)#DomainTypedValue[CTIntType]

    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
    IntegerValuesFactory
  6. abstract def ByteValue(origin: ValueOrigin, value: Byte): (RecordConstraints.this)#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
    IntegerValuesFactory
  7. abstract def ByteValue(origin: ValueOrigin): (RecordConstraints.this)#DomainTypedValue[CTIntType]

    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
    IntegerValuesFactory
  8. abstract def CharValue(origin: ValueOrigin, value: Char): (RecordConstraints.this)#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
    IntegerValuesFactory
  9. abstract def CharValue(origin: ValueOrigin): (RecordConstraints.this)#DomainTypedValue[CTIntType]

    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
    IntegerValuesFactory
  10. abstract def ClassCastException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  11. abstract def ClassNotFoundException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink
    Definition Classes
    ExceptionsFactory
  12. abstract def ClassValue(origin: ValueOrigin, t: Type): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
  13. abstract val DomainReferenceValue: ClassTag[(RecordConstraints.this)#DomainReferenceValue]

    Permalink

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

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

    val DomainReferenceValue(v) = value // of type "DomainValue"
    // v is now of the type DomainReferenceValue
    Definition Classes
    ValuesDomain
  14. implicit abstract val DomainValue: ClassTag[(RecordConstraints.this)#DomainValue]

    Permalink

    The class tag for the type DomainValue.

    The class tag for the type DomainValue.

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

    Initialization

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

    val DomainValueTag : ClassTag[DomainValue] = implicitly

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

    Definition Classes
    ValuesDomain
  15. abstract def IllegalMonitorStateException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  16. abstract def InitializedArrayValue(origin: ValueOrigin, arrayType: ArrayType, counts: Chain[Int]): (RecordConstraints.this)#DomainReferenceValue

    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
    origin

    Information about the origin of the value.

    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
    ReferenceValuesFactory
  17. abstract def InitializedObjectValue(origin: ValueOrigin, objectType: ObjectType): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
  18. abstract def IntegerValue(origin: ValueOrigin, value: Int): (RecordConstraints.this)#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
    IntegerValuesFactory
  19. abstract def IntegerValue(origin: ValueOrigin): (RecordConstraints.this)#DomainTypedValue[CTIntType]

    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
    IntegerValuesFactory
  20. abstract def MetaInformationUpdateIllegalValue: MetaInformationUpdate[(RecordConstraints.this)#DomainIllegalValue]

    Permalink

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

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

    Definition Classes
    ValuesDomain
  21. abstract def NegativeArraySizeException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  22. abstract def NewObject(origin: ValueOrigin, objectType: ObjectType): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
    Note

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

  23. abstract def NonNullObjectValue(origin: ValueOrigin, objectType: ObjectType): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
  24. abstract def NullPointerException(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  25. abstract def NullValue(origin: ValueOrigin): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
  26. abstract def ReferenceValue(origin: ValueOrigin, referenceType: ReferenceType): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
  27. abstract def ReturnAddressValue(address: PC): (RecordConstraints.this)#DomainReturnAddressValue

    Permalink

    Factory method to create an instance of a ReturnAddressValue.

    Factory method to create an instance of a ReturnAddressValue.

    Definition Classes
    ValuesDomain
  28. abstract def ShortValue(origin: ValueOrigin, value: Short): (RecordConstraints.this)#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
    IntegerValuesFactory
  29. abstract def ShortValue(origin: ValueOrigin): (RecordConstraints.this)#DomainTypedValue[CTIntType]

    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
    IntegerValuesFactory
  30. abstract def StringValue(origin: ValueOrigin, value: String): (RecordConstraints.this)#DomainReferenceValue

    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
    ReferenceValuesFactory
  31. abstract val TheIllegalValue: (RecordConstraints.this)#DomainIllegalValue

    Permalink

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    ValuesDomain
  32. abstract val TheReturnAddressValues: (RecordConstraints.this)#DomainReturnAddressValues

    Permalink

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    ValuesDomain
  33. abstract def Throwable(origin: ValueOrigin): (RecordConstraints.this)#ExceptionValue

    Permalink

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

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

    Definition Classes
    ExceptionsFactory
  34. abstract def aaload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  35. abstract def aastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  36. abstract def arraylength(pc: PC, arrayref: (RecordConstraints.this)#DomainValue): Computation[(RecordConstraints.this)#DomainValue, (RecordConstraints.this)#ExceptionValue]

    Permalink

    Returns the array's length or throws a NullPointerException.

    Returns the array's length or throws a NullPointerException.

    Definition Classes
    ReferenceValuesDomain
  37. abstract def baload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  38. abstract def bastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  39. abstract def caload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  40. abstract def castore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  41. abstract def daload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  42. abstract def dastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  43. abstract def faload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  44. abstract def fastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  45. abstract def i2b(pc: PC, value: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  46. abstract def i2c(pc: PC, value: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  47. abstract def i2s(pc: PC, value: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  48. abstract def iadd(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  49. abstract def iaload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  50. abstract def iand(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  51. abstract def iastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  52. abstract def idiv(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#IntegerValueOrArithmeticException

    Permalink
    Definition Classes
    IntegerValuesDomain
  53. abstract def iinc(pc: PC, value: (RecordConstraints.this)#DomainValue, increment: Int): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  54. abstract def imul(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  55. abstract def ineg(pc: PC, value: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  56. abstract def intAreEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#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
    IntegerValuesDomain
  57. abstract def intIsLessThan(pc: PC, smallerValue: (RecordConstraints.this)#DomainValue, largerValue: (RecordConstraints.this)#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.

    smallerValue

    A value with computational type integer.

    largerValue

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  58. abstract def intIsLessThanOrEqualTo(pc: PC, smallerOrEqualValue: (RecordConstraints.this)#DomainValue, equalOrLargerValue: (RecordConstraints.this)#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.

    smallerOrEqualValue

    A value with computational type integer.

    equalOrLargerValue

    A value with computational type integer.

    Definition Classes
    IntegerValuesDomain
  59. abstract def intIsSomeValueInRange(pc: PC, value: (RecordConstraints.this)#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
    IntegerValuesDomain
  60. abstract def intIsSomeValueNotInRange(pc: PC, value: (RecordConstraints.this)#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
    IntegerValuesDomain
  61. abstract def ior(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  62. abstract def irem(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#IntegerValueOrArithmeticException

    Permalink
    Definition Classes
    IntegerValuesDomain
  63. abstract def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

    Permalink

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

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

    Definition Classes
    ReferenceValuesDomain
  64. abstract def isValueSubtypeOf(value: (RecordConstraints.this)#DomainValue, supertype: ReferenceType): Answer

    Permalink

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

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

    Definition Classes
    ReferenceValuesDomain
    Note

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

  65. abstract def ishl(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  66. abstract def ishr(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  67. abstract def isub(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  68. abstract def iushr(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  69. abstract def ixor(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink
    Definition Classes
    IntegerValuesDomain
  70. abstract def laload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  71. abstract def lastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  72. abstract def multianewarray(pc: PC, counts: (RecordConstraints.this)#Operands, arrayType: ArrayType): Computation[(RecordConstraints.this)#DomainValue, (RecordConstraints.this)#ExceptionValue]

    Permalink

    Creates a representation of a new multidimensional array.

    Creates a representation of a new multidimensional array. The return value is either a new array or a NegativeArraySizeException if count is negative.

    Definition Classes
    ReferenceValuesDomain
  73. abstract def newarray(pc: PC, count: (RecordConstraints.this)#DomainValue, componentType: FieldType): Computation[(RecordConstraints.this)#DomainValue, (RecordConstraints.this)#ExceptionValue]

    Permalink

    The return value is either a new array or a NegativeArraySizeException if count is negative.

    The return value is either a new array or a NegativeArraySizeException if count is negative.

    Definition Classes
    ReferenceValuesDomain
  74. abstract def refAreEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): Answer

    Permalink

    Compares the given values for reference equality.

    Compares the given values for reference equality. Returns Yes if both values point to the same instance and returns No 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
  75. abstract def refIsNull(pc: PC, value: (RecordConstraints.this)#DomainValue): Answer

    Permalink

    Determines whether the given value is null (Yes), maybe null (Unknown) or is not null (No).

    Determines whether the given value is null (Yes), maybe null (Unknown) or is not null (No).

    value

    A value of computational type reference.

    Definition Classes
    ReferenceValuesDomain
  76. abstract def saload(pc: PC, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ReferenceValuesDomain
  77. abstract def sastore(pc: PC, value: (RecordConstraints.this)#DomainValue, index: (RecordConstraints.this)#DomainValue, arrayref: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ReferenceValuesDomain

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to any2stringadd[RecordConstraints] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RecordConstraints, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to ArrowAssoc[RecordConstraints] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def IntegerConstant0: (RecordConstraints.this)#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
  7. def MethodHandle(origin: ValueOrigin, handle: MethodHandle): (RecordConstraints.this)#DomainReferenceValue

    Permalink

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

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

    handle

    A valid method handle.

    returns

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

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

    Permalink

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

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

    descriptor

    A valid method descriptor.

    returns

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

    Definition Classes
    ReferenceValuesFactory
  9. 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.

  10. final def VMArithmeticException(pc: PC): (RecordConstraints.this)#ExceptionValue

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ExceptionsFactory
  19. def allConstraints: Set[(RecordConstraints.this)#ReifiedConstraint]

    Permalink

    Returns the set of constraints.

  20. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def ensuring(cond: (RecordConstraints) ⇒ Boolean, msg: ⇒ Any): RecordConstraints

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to Ensuring[RecordConstraints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: (RecordConstraints) ⇒ Boolean): RecordConstraints

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to Ensuring[RecordConstraints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean, msg: ⇒ Any): RecordConstraints

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to Ensuring[RecordConstraints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean): RecordConstraints

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to Ensuring[RecordConstraints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from RecordConstraints to StringFormat[RecordConstraints] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  30. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. def intAreNotEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#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
  33. def intEstablishAreEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

    Definition Classes
    ReifiedConstraintsIntegerValuesDomain
    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.

  34. def intEstablishAreNotEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

    Definition Classes
    ReifiedConstraintsIntegerValuesDomain
    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.

  35. def intEstablishIsLessThan(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

    Definition Classes
    ReifiedConstraintsIntegerValuesDomain
    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.

  36. def intEstablishIsLessThanOrEqualTo(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

    Definition Classes
    ReifiedConstraintsIntegerValuesDomain
    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.

  37. def intEstablishValue(pc: PC, theValue: Int, value: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#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
    ReifiedConstraintsIntegerValuesDomain
  38. def intIs0(pc: PC, value: (RecordConstraints.this)#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
  39. def intIsGreaterThan(pc: PC, largerValue: (RecordConstraints.this)#DomainValue, smallerValue: (RecordConstraints.this)#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
  40. def intIsGreaterThan0(pc: PC, value: (RecordConstraints.this)#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
  41. def intIsGreaterThanOrEqualTo(pc: PC, largerOrEqualValue: (RecordConstraints.this)#DomainValue, smallerOrEqualValue: (RecordConstraints.this)#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
  42. def intIsGreaterThanOrEqualTo0(pc: PC, value: (RecordConstraints.this)#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
  43. def intIsLessThan0(pc: PC, value: (RecordConstraints.this)#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
  44. def intIsLessThanOrEqualTo0(pc: PC, value: (RecordConstraints.this)#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
  45. def intIsNot0(pc: PC, value: (RecordConstraints.this)#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
  46. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  47. final def justThrows(value: (RecordConstraints.this)#ExceptionValue): ThrowsException[(RecordConstraints.this)#ExceptionValues]

    Permalink
    Definition Classes
    ReferenceValuesFactory
  48. def mergeDomainValues(pc: PC, v1: (RecordConstraints.this)#DomainValue, v2: (RecordConstraints.this)#DomainValue): (RecordConstraints.this)#DomainValue

    Permalink

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

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

    This operation is commutative.

    Definition Classes
    ValuesDomain
  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  50. def nextConstraint(constraint: (RecordConstraints.this)#ReifiedConstraint): Unit

    Permalink

    (Indirectly) called by OPAL for a new value-based constraint.

    (Indirectly) called by OPAL for a new value-based constraint.

    Definition Classes
    RecordConstraintsReifiedConstraints
  51. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  53. 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
  54. def refAreNotEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue): Answer

    Permalink

    Compares the given values for reference inequality.

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

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

    value1

    A value of computational type reference.

    value2

    A value of computational type reference.

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

    Permalink

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

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

    Definition Classes
    ReifiedConstraintsReferenceValuesDomain
  56. def refEstablishAreNotEqual(pc: PC, value1: (RecordConstraints.this)#DomainValue, value2: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

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

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

    Definition Classes
    ReifiedConstraintsReferenceValuesDomain
  57. def refEstablishIsNonNull(pc: PC, value: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

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

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

    Definition Classes
    ReifiedConstraintsReferenceValuesDomain
  58. def refEstablishIsNull(pc: PC, value: (RecordConstraints.this)#DomainValue, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

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

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

    Definition Classes
    ReifiedConstraintsReferenceValuesDomain
  59. def refIsNonNull(pc: PC, value: (RecordConstraints.this)#DomainValue): Answer

    Permalink

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

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

    value

    A value of computational type reference.

    Definition Classes
    ReferenceValuesDomain
  60. def refSetUpperTypeBoundOfTopOperand(pc: PC, bound: ReferenceType, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

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

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

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

    Definition Classes
    ReifiedConstraintsReferenceValuesDomain
  61. def refTopOperandIsNull(pc: PC, operands: (RecordConstraints.this)#Operands, locals: (RecordConstraints.this)#Locals): ((RecordConstraints.this)#Operands, (RecordConstraints.this)#Locals)

    Permalink

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

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

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

    Definition Classes
    ReifiedConstraintsReferenceValuesDomain
  62. def summarize(pc: PC, values: Iterable[(RecordConstraints.this)#DomainValue]): (RecordConstraints.this)#DomainValue

    Permalink

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

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

    pc

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

    values

    An Iterable over one or more values.

    Definition Classes
    ValuesDomain
    Note

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

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

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

    Permalink
    Definition Classes
    ReferenceValuesFactory
  65. def toString(): String

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

    Permalink

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

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

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

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

    Implementing typeOfValue

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

    Example

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. def [B](y: B): (RecordConstraints, B)

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

Inherited from ReifiedConstraints

Inherited from ReferenceValuesDomain

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from IntegerValuesDomain

Inherited from IntegerValuesFactory

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped