Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package opalj

    OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.

    OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.

    Its main components are:

    • a library (Common) which provides generally useful data-structures and algorithms for static analyses.
    • a framework for parsing Java bytecode (Bytecode Infrastructure) that can be used to create arbitrary representations.
    • a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler).
    • a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
    • a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
    • a library to extract dependencies between code elements and to facilitate checking architecture definitions.
    • a library for the lightweight manipulation and creation of Java bytecode.

    General Design Decisions

    Thread Safety

    Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)

    No null Values

    Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.

    No Typecasts for Collections

    For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety. Furthermore, the concrete data-structure is always considered an implementation detail and may change at any time.

    Assertions

    OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.

    Definition Classes
    org
  • package ai

    Implementation of an abstract interpretation (ai) framework – also referred to as OPAL.

    Implementation of an abstract interpretation (ai) framework – also referred to as OPAL.

    Please note, that OPAL/the abstract interpreter just refers to the classes and traits defined in this package (ai). The classes and traits defined in the sub-packages (in particular in domain) are not considered to be part of the core of OPAL/the abstract interpreter.

    Definition Classes
    opalj
    Note

    This framework assumes that the analyzed bytecode is valid; i.e., the JVM's bytecode verifier would be able to verify the code. Furthermore, load-time errors (e.g., LinkageErrors) are – by default – completely ignored to facilitate the analysis of parts of a project. In general, if the presented bytecode is not valid, the result is undefined (i.e., OPAL may report meaningless results, crash or run indefinitely).

    See also

    org.opalj.ai.Domain - The core interface between the abstract interpretation framework and the abstract domain that is responsible for performing the abstract computations.

    org.opalj.ai.AI - Implements the abstract interpreter that processes a methods code and uses an analysis-specific domain to perform the abstract computations.

  • package domain

    This package contains definitions of common domains that can be used for the implementation of analyses.

    This package contains definitions of common domains that can be used for the implementation of analyses.

    Types of Domains

    In general, we distinguish two types of domains. First, domains that define a general interface (on top of the one defined by Domain), but do not directly provide an implementation. Hence, whenever you develop a new Domain you should consider implementing/using these domains to maximize reusability. Second, Domains that implement a specific interface (trait). In this case, we further distinguish between domains that provide a default implementation (per interface only one of these Domains can be used to create a final Domain) and those that can be stacked and basically refine the overall functionality.

    Examples

    • Domains That Define a General Interface
      • Origin defines two types which domains that provide information abou the origin of a value should consider to implement.
      • TheProject defines a standard mechanism how a domain can access the current project.
      • TheClassHierarchy defines a standard mechanism how to get the project's class hierarchy.
      • ...
    • Domains That Provide a Default Implementation
      • Origin defines the functionality to return a value's origin if the value supports that.
      • TheProject default implementation of the TheClassHierarchy trait that uses the project's class hierarchy.
      • DefaultHandlingOfMethodResults basically implements a Domain's methods related to return instructions an uncaught exceptions.
      • ...
    • Domains That Implement Stackable Functionality
      • RecordThrownExceptions records information about all uncaught exceptions by intercepting a Domain's respective methods. However, it does provide a default implementation. Hence, a typical pattern is:
    class MyDomain extends Domain with ...
        with DefaultHandlingOfMethodResults with RecordThrownExceptions

    Thread Safety

    Unless explicitly documented, a domain is never thread-safe. The general programming model is to use one Domain object per code block/method and therefore, thread-safety is not required for Domains that are used for the evaluation of methods. However domains that are used to adapt/transfer values should be thread safe (see ValuesCoordinatingDomain for further details).

    Definition Classes
    ai
  • package l1

    Commonly useful methods.

    Commonly useful methods.

    Definition Classes
    domain
  • ArrayValues
  • ClassValues
  • ConcretePrimitiveValuesConversions
  • ConstraintsBetweenIntegerValues
  • DefaultArrayValuesBinding
  • DefaultClassValuesBinding
  • DefaultDomain
  • DefaultDomainWithCFG
  • DefaultDomainWithCFGAndDefUse
  • DefaultIntegerRangeValues
  • DefaultIntegerSetValues
  • DefaultIntegerValues
  • DefaultIntervalValuesDomain
  • DefaultJavaObjectToDomainValueConversion
  • DefaultLongSetValues
  • DefaultLongValues
  • DefaultReferenceValuesBinding
  • DefaultReferenceValuesDomain
  • DefaultSetValuesDomain
  • DefaultSingletonValuesDomain
  • DefaultStringValuesBinding
  • IfNullParameterAnalysis
  • IntegerRangeValues
  • IntegerSetValues
  • IntegerValues
  • LongSetValues
  • LongSetValuesShiftOperators
  • LongValues
  • LongValuesShiftOperators
  • MaxArrayLengthRefinement
  • MethodReturnValuesAnalysis
  • NullPropertyRefinement
  • OwnershipAnalysis
  • RecordAllThrownExceptions
  • ReferenceValues
  • RefinedReturnType
  • ReflectiveInvoker
  • SimpleDefUseAnalysis
  • StringBuilderValues
  • StringValues

trait StringValues extends ReferenceValues with DefaultJavaObjectToDomainValueConversion with MethodCallsDomain with PostEvaluationMemoryManagement

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringValues
  2. PostEvaluationMemoryManagement
  3. CoreDomainFunctionality
  4. SubroutinesDomain
  5. MethodCallsDomain
  6. DefaultJavaObjectToDomainValueConversion
  7. AsDomainValue
  8. ReferenceValues
  9. Origin
  10. DefaultTypeLevelReferenceValues
  11. TypeLevelReferenceValues
  12. AsJavaObject
  13. GeneralizedArrayHandling
  14. ReferenceValuesDomain
  15. ReferenceValuesFactory
  16. ExceptionsFactory
  17. DefaultDomainValueBinding
  18. ValuesDomain
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class IllegalValue extends Value

    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.

  2. trait RETValue extends Value
    Definition Classes
    ValuesDomain
  3. class ReturnAddressValue extends RETValue

    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.

  4. class ReturnAddressValues extends RETValue

    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
  5. trait TypedValue[+T <: Type] extends Value with KnownType
    Definition Classes
    ValuesDomain
  6. trait Value extends AnyRef

    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.

  7. trait MultipleOriginsValue extends (Origin.this)#ValueWithOriginInformation

    Marker trait which should be mixed in by DomainValue classes that capture information about all (multiple) origins of a value.

    Marker trait which should be mixed in by DomainValue classes that capture information about all (multiple) origins of a value.

    Definition Classes
    Origin
  8. trait SingleOriginValue extends (Origin.this)#ValueWithOriginInformation

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

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

    Definition Classes
    Origin
  9. trait ValueWithOriginInformation extends AnyRef

    Common supertrait of all domain values which provide comprehensive origin information.

    Common supertrait of all domain values which provide comprehensive origin information.

    Definition Classes
    Origin
  10. trait ArrayAbstraction extends AnyRef
    Definition Classes
    TypeLevelReferenceValues
  11. trait SReferenceValue[T <: ReferenceType] extends (TypeLevelReferenceValues.this)#ReferenceValue

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

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

    Attributes
    protected[this]
    Definition Classes
    TypeLevelReferenceValues
  12. class ArrayValue extends (ReferenceValues.this)#ArrayValue with (ReferenceValues.this)#NonNullSingleOriginSReferenceValue
    Attributes
    protected
    Definition Classes
    ReferenceValues
  13. class MObjectValue extends (ReferenceValues.this)#MObjectValue with (ReferenceValues.this)#ObjectValue
    Attributes
    protected
    Definition Classes
    ReferenceValues
  14. class MultipleReferenceValues extends (ReferenceValues.this)#ReferenceValue with (ReferenceValues.this)#MultipleOriginsValue

    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
  15. trait NonNullSingleOriginReferenceValue extends (ReferenceValues.this)#SingleOriginReferenceValue
    Definition Classes
    ReferenceValues
  16. trait NonNullSingleOriginSReferenceValue extends (ReferenceValues.this)#NonNullSingleOriginReferenceValue
    Definition Classes
    ReferenceValues
  17. class NullValue extends (ReferenceValues.this)#NullValue with (ReferenceValues.this)#SingleOriginReferenceValue
    Attributes
    protected
    Definition Classes
    ReferenceValues
  18. trait ObjectValue extends (ReferenceValues.this)#ObjectValue with (ReferenceValues.this)#NonNullSingleOriginReferenceValue
    Definition Classes
    ReferenceValues
  19. trait ReferenceValue extends (ReferenceValues.this)#ReferenceValue

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

    Attributes
    protected
    Definition Classes
    ReferenceValues
  21. trait SingleOriginReferenceValue extends (ReferenceValues.this)#ReferenceValue with (ReferenceValues.this)#SingleOriginValue with UID

    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.

  22. abstract type AReferenceValue <: (StringValues.this)#ReferenceValue with (StringValues.this)#DomainReferenceValue
  23. type ArrayLoadResult = Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValues]

    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
  24. type ArrayStoreResult = Computation[Nothing, (StringValues.this)#ExceptionValues]

    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
  25. abstract type DomainArrayValue <: (StringValues.this)#ArrayValue with (StringValues.this)#DomainSingleOriginReferenceValue
  26. final type DomainIllegalValue = (StringValues.this)#IllegalValue

    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
  27. abstract type DomainMultipleReferenceValues <: (StringValues.this)#MultipleReferenceValues with (StringValues.this)#AReferenceValue
    Definition Classes
    ReferenceValues
  28. abstract type DomainNullValue <: (StringValues.this)#NullValue with (StringValues.this)#DomainSingleOriginReferenceValue
  29. abstract type DomainObjectValue <: (StringValues.this)#ObjectValue with (StringValues.this)#DomainSingleOriginReferenceValue
  30. abstract type DomainReferenceValue >: Null <: (StringValues.this)#ReferenceValue with (StringValues.this)#DomainTypedValue[ReferenceType]
    Definition Classes
    ValuesDomain
  31. final type DomainReturnAddressValue = (StringValues.this)#ReturnAddressValue

    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
  32. final type DomainReturnAddressValues = (StringValues.this)#ReturnAddressValues
  33. abstract type DomainSingleOriginReferenceValue <: (StringValues.this)#SingleOriginReferenceValue with (StringValues.this)#AReferenceValue
    Definition Classes
    ReferenceValues
  34. abstract type DomainStringValue <: (StringValues.this)#StringValue with (StringValues.this)#DomainObjectValue
  35. final type DomainTypedValue[+T <: Type] = (StringValues.this)#TypedValue[T]
  36. final type DomainValue = (StringValues.this)#Value

    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
  37. type ExceptionValue = (StringValues.this)#DomainReferenceValue

    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
  38. type ExceptionValues = Iterable[(StringValues.this)#ExceptionValue]

    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
  39. type Locals = collection.mutable.Locals[(StringValues.this)#DomainValue]

    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
  40. type LocalsArray = Array[(StringValues.this)#Locals]
    Definition Classes
    ValuesDomain
  41. type MethodCallResult = Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValues]
    Definition Classes
    MethodCallsDomain
  42. type Operands = Chain[(StringValues.this)#DomainValue]

    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
  43. type OperandsArray = Array[(StringValues.this)#Operands]
    Definition Classes
    ValuesDomain
  44. type RefId = Int

    Two domain values that have the same refid are guaranteed to refer to the same object at runtime (must-alias).

    Two domain values that have the same refid are guaranteed to refer to the same object at runtime (must-alias).

    The refid 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 values may or may not refer to the same object on the heap/stack.

    RefIds 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
  45. type Refinements = IdentityHashMap[(StringValues.this)#AReferenceValue, (StringValues.this)#AReferenceValue]

    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
  46. class StringValue extends (StringValues.this)#SObjectValue

    Attributes
    protected

Abstract Value Members

  1. abstract val AReferenceValue: ClassTag[(StringValues.this)#AReferenceValue]
    Definition Classes
    ReferenceValues
  2. abstract def ArithmeticException(origin: ValueOrigin): (StringValues.this)#ExceptionValue

    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
  3. abstract def ArrayIndexOutOfBoundsException(origin: ValueOrigin): (StringValues.this)#ExceptionValue

    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
  4. abstract def ArrayStoreException(origin: ValueOrigin): (StringValues.this)#ExceptionValue

    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
  5. abstract def ArrayValue(pc: PC, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ArrayType, refId: Int): (StringValues.this)#DomainArrayValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  6. abstract def ClassCastException(origin: ValueOrigin): (StringValues.this)#ExceptionValue

    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
  7. abstract def ClassNotFoundException(origin: ValueOrigin): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  8. abstract val DomainArrayValue: ClassTag[(StringValues.this)#DomainArrayValue]
    Definition Classes
    ReferenceValues
  9. abstract val DomainMultipleReferenceValues: ClassTag[(StringValues.this)#DomainMultipleReferenceValues]
    Definition Classes
    ReferenceValues
  10. abstract val DomainNullValue: ClassTag[(StringValues.this)#DomainNullValue]
    Definition Classes
    ReferenceValues
  11. abstract val DomainObjectValue: ClassTag[(StringValues.this)#DomainObjectValue]
    Definition Classes
    ReferenceValues
  12. abstract val DomainReferenceValue: ClassTag[(StringValues.this)#DomainReferenceValue]

    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
  13. abstract val DomainSingleOriginReferenceValue: ClassTag[(StringValues.this)#DomainSingleOriginReferenceValue]
    Definition Classes
    ReferenceValues
  14. abstract val DomainStringValue: ClassTag[(StringValues.this)#DomainStringValue]
  15. abstract def IllegalMonitorStateException(origin: ValueOrigin): (StringValues.this)#ExceptionValue

    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 MultipleReferenceValues(values: UIDSet[(StringValues.this)#DomainSingleOriginReferenceValue], isNull: Answer, isPrecise: Boolean, upperTypeBound: UIDSet[_ <: ReferenceType], refId: Int): (StringValues.this)#DomainMultipleReferenceValues
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  17. abstract def MultipleReferenceValues(values: UIDSet[(StringValues.this)#DomainSingleOriginReferenceValue]): (StringValues.this)#DomainMultipleReferenceValues
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  18. abstract def NegativeArraySizeException(origin: ValueOrigin): (StringValues.this)#ExceptionValue

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

    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
  20. abstract def NullValue(pc: PC): (StringValues.this)#DomainNullValue

    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
    TypeLevelReferenceValuesReferenceValuesFactory
  21. abstract def ObjectValue(pc: PC, isNull: Answer, upperTypeBound: UIDSet[ObjectType], refId: Int): (StringValues.this)#DomainObjectValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  22. abstract def ObjectValue(pc: PC, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType, refId: Int): (StringValues.this)#DomainObjectValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  23. abstract def StringValue(origin: ValueOrigin, value: String, refId: (StringValues.this)#RefId): (StringValues.this)#DomainStringValue
  24. abstract def Throwable(origin: ValueOrigin): (StringValues.this)#ExceptionValue

    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
  25. abstract def invokedynamic(pc: PC, bootstrapMethod: BootstrapMethod, name: String, methodDescriptor: MethodDescriptor, operands: (StringValues.this)#Operands): (StringValues.this)#MethodCallResult
    Definition Classes
    MethodCallsDomain
  26. abstract def invokeinterface(pc: PC, declaringClass: ObjectType, name: String, methodDescriptor: MethodDescriptor, operands: (StringValues.this)#Operands): (StringValues.this)#MethodCallResult
    Definition Classes
    MethodCallsDomain
  27. abstract def invokestatic(pc: PC, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: (StringValues.this)#Operands): (StringValues.this)#MethodCallResult
    Definition Classes
    MethodCallsDomain
  28. abstract def invokevirtual(pc: PC, declaringClass: ReferenceType, name: String, methodDescriptor: MethodDescriptor, operands: (StringValues.this)#Operands): (StringValues.this)#MethodCallResult
    Definition Classes
    MethodCallsDomain
  29. abstract def isSubtypeOf(subtype: ReferenceType, supertype: ReferenceType): Answer

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

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

    Definition Classes
    ReferenceValuesDomain

Concrete Value Members

  1. implicit object SingleOriginValueOrdering extends Ordering[(Origin.this)#SingleOriginValue]
    Definition Classes
    Origin
  2. object ArrayValue

    Enables matching of DomainValues that are array values.

    Enables matching of DomainValues that are array values.

    Definition Classes
    DefaultTypeLevelReferenceValues
  3. object MObjectValue
  4. object SObjectValue
  5. object IsNull
    Definition Classes
    TypeLevelReferenceValues
  6. object IsPrecise
    Definition Classes
    TypeLevelReferenceValues
  7. object UpperTypeBound
    Definition Classes
    TypeLevelReferenceValues
  8. implicit object DomainSingleOriginReferenceValueOrdering extends Ordering[(ReferenceValues.this)#DomainSingleOriginReferenceValue]

    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
  9. object MultipleReferenceValues
    Definition Classes
    ReferenceValues
  10. object RefId

    Extractor for reference ids.

    Extractor for reference ids.

    Definition Classes
    ReferenceValues
  11. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. final def ##(): Int
    Definition Classes
    AnyRef → Any
  13. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def ArrayValue(pc: PC, arrayType: ArrayType): (StringValues.this)#DomainArrayValue

    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.

  15. def ClassValue(pc: PC, t: Type): (StringValues.this)#DomainObjectValue

    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
    ReferenceValuesTypeLevelReferenceValuesReferenceValuesFactory
  16. final val DomainValue: ClassTag[(StringValues.this)#DomainValue]

    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
  17. def InitializedArrayValue(pc: PC, arrayType: ArrayType, counts: Chain[Int]): (StringValues.this)#DomainArrayValue

    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
  18. def InitializedObjectValue(pc: PC, objectType: ObjectType): (StringValues.this)#DomainObjectValue

    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
  19. final val MetaInformationUpdateIllegalValue: MetaInformationUpdate[(StringValues.this)#DomainIllegalValue]

    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
  20. def MethodHandle(origin: ValueOrigin, handle: MethodHandle): (StringValues.this)#DomainReferenceValue

    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
  21. def MethodType(origin: ValueOrigin, descriptor: MethodDescriptor): (StringValues.this)#DomainReferenceValue

    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
  22. def NewArray(pc: PC, counts: (StringValues.this)#Operands, arrayType: ArrayType): (StringValues.this)#DomainArrayValue

    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
  23. def NewArray(pc: PC, count: (StringValues.this)#DomainValue, arrayType: ArrayType): (StringValues.this)#DomainArrayValue

    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
  24. def NewObject(origin: ValueOrigin, objectType: ObjectType): (StringValues.this)#DomainObjectValue

    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).

  25. def NonNullObjectValue(pc: PC, objectType: ObjectType): (StringValues.this)#DomainObjectValue

    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
  26. def ObjectValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ObjectType): (StringValues.this)#DomainObjectValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  27. def ObjectValue(origin: ValueOrigin, isNull: Answer, upperTypeBound: UIDSet[ObjectType]): (StringValues.this)#DomainObjectValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  28. def ObjectValue(pc: PC, upperTypeBound: UIDSet[ObjectType]): (StringValues.this)#DomainObjectValue

    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
  29. def ObjectValue(pc: PC, objectType: ObjectType): (StringValues.this)#DomainObjectValue

    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
  30. final def RefIdUpdate[T](value: T): MetaInformationUpdate[T]

    Creates an update object that characterizes a reference id update.

    Creates an update object that characterizes a reference id update.

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

    Definition Classes
    ReferenceValues
    Annotations
    @inline()
  31. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, upperTypeBound: UIDSet[_ <: ReferenceType], refId: (StringValues.this)#RefId): (StringValues.this)#DomainSingleOriginReferenceValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  32. final def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType): (StringValues.this)#DomainSingleOriginReferenceValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  33. def ReferenceValue(origin: ValueOrigin, isNull: Answer, isPrecise: Boolean, theUpperTypeBound: ReferenceType, refId: (StringValues.this)#RefId): (StringValues.this)#DomainSingleOriginReferenceValue
    Attributes
    protected[org.opalj.ai.domain]
    Definition Classes
    ReferenceValues
  34. def ReferenceValue(pc: PC, upperTypeBound: ReferenceType): (StringValues.this)#AReferenceValue

    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
  35. final def ReturnAddressValue(address: Int): (StringValues.this)#ReturnAddressValue

    Factory method to create an instance of a ReturnAddressValue.

    Factory method to create an instance of a ReturnAddressValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  36. final def StringValue(origin: ValueOrigin, value: String): (StringValues.this)#DomainObjectValue

    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
  37. final def StructuralUpdateIllegalValue: StructuralUpdate[Nothing]

    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.

  38. final val TheIllegalValue: (StringValues.this)#DomainIllegalValue

    The singleton instance of the IllegalValue.

    The singleton instance of the IllegalValue.

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  39. final val TheReturnAddressValues: (StringValues.this)#ReturnAddressValues

    The singleton instance of ReturnAddressValues

    The singleton instance of ReturnAddressValues

    Definition Classes
    DefaultDomainValueBindingValuesDomain
  40. final def VMArithmeticException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  41. final def VMArrayIndexOutOfBoundsException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  42. final def VMArrayStoreException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  43. final def VMClassCastException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  44. final def VMClassNotFoundException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  45. final def VMIllegalMonitorStateException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  46. final def VMNegativeArraySizeException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  47. final def VMNullPointerException(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  48. final def VMThrowable(pc: PC): (StringValues.this)#ExceptionValue
    Definition Classes
    ExceptionsFactory
  49. def aaload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  50. def aastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  51. def abstractInterpretationEnded(aiResult: AIResult { val domain: org.opalj.ai.<refinement>.type }): Unit

    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
  52. def afterBaseJoin(pc: PC): Unit

    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
    CoreDomainFunctionality
  53. def afterEvaluation(pc: PC, instruction: Instruction, oldOperands: (StringValues.this)#Operands, oldLocals: (StringValues.this)#Locals, targetPC: PC, isExceptionalControlFlow: Boolean, newOperands: (StringValues.this)#Operands, newLocals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
    PostEvaluationMemoryManagementCoreDomainFunctionality
    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).

  54. def arraylength(pc: PC, arrayref: (StringValues.this)#DomainValue): Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValue]

    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.

  55. def arrayload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult

    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.

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

    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.

  57. def asArrayAbstraction(value: (StringValues.this)#DomainValue): (StringValues.this)#ArrayAbstraction
    Definition Classes
    TypeLevelReferenceValues
  58. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  59. def asObjectValue(value: (StringValues.this)#DomainValue): (StringValues.this)#DomainObjectValue
    Definition Classes
    TypeLevelReferenceValues
  60. def asReferenceValue(value: (StringValues.this)#DomainValue): (StringValues.this)#AReferenceValue

    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
  61. def baload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  62. def bastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  63. def beforeBaseJoin(pc: PC): Unit

    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.

  64. def caload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  65. def castore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  66. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  67. def daload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  68. def dastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  69. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  71. def evaluationCompleted(pc: PC, worklist: Chain[PC], evaluated: Chain[PC], operandsArray: (StringValues.this)#OperandsArray, localsArray: (StringValues.this)#LocalsArray, tracer: Option[AITracer]): Unit

    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
  72. def faload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  73. def fastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  74. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  75. def flow(currentPC: PC, currentOperands: (StringValues.this)#Operands, currentLocals: (StringValues.this)#Locals, successorPC: PC, isSuccessorScheduled: Answer, isExceptionalControlFlow: Boolean, abruptSubroutineTerminationCount: Int, wasJoinPerformed: Boolean, worklist: Chain[PC], operandsArray: (StringValues.this)#OperandsArray, localsArray: (StringValues.this)#LocalsArray, tracer: Option[AITracer]): Chain[PC]

    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.

  76. def foreachOrigin(value: (StringValues.this)#DomainValue, f: (ValueOrigin) ⇒ Unit): Unit
    Definition Classes
    Origin
  77. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  78. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  79. def iaload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  80. def iastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  81. def invokespecial(pc: PC, declaringClass: ObjectType, isInterface: Boolean, name: String, methodDescriptor: MethodDescriptor, operands: (StringValues.this)#Operands): (StringValues.this)#MethodCallResult
    Definition Classes
    StringValuesMethodCallsDomain
  82. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  83. def isNull(values: Iterable[(StringValues.this)#AReferenceValue]): Answer

    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
  84. def isPrecise(values: Iterable[(StringValues.this)#AReferenceValue]): Boolean

    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
  85. final def isValueSubtypeOf(value: (StringValues.this)#DomainValue, supertype: ReferenceType): Answer

    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.

  86. def join(pc: PC, thisOperands: (StringValues.this)#Operands, thisLocals: (StringValues.this)#Locals, otherOperands: (StringValues.this)#Operands, otherLocals: (StringValues.this)#Locals): Update[((StringValues.this)#Operands, (StringValues.this)#Locals)]

    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.

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

    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
    CoreDomainFunctionality
  88. def joinValues(pc: PC, left: (StringValues.this)#DomainValue, right: (StringValues.this)#DomainValue): Update[(StringValues.this)#DomainValue]
    Attributes
    protected[this]
    Definition Classes
    CoreDomainFunctionality
  89. def jumpToSubroutine(pc: PC, branchTarget: PC, returnTarget: PC): Unit

    pc

    The pc of the jsr(w) instruction.

    Definition Classes
    SubroutinesDomain
  90. final def justThrows(value: (StringValues.this)#ExceptionValue): ThrowsException[(StringValues.this)#ExceptionValues]
    Definition Classes
    ReferenceValuesFactory
  91. def laload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  92. def lastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  93. def mergeDEComputations(pc: PC, c1: Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValue], c2: Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValue]): Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValue]

    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
  94. def mergeDEsComputations(pc: PC, c1: Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValues], c2: Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValues]): Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValues]

    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
  95. def mergeDomainValues(pc: PC, v1: (StringValues.this)#DomainValue, v2: (StringValues.this)#DomainValue): (StringValues.this)#DomainValue

    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
  96. def mergeEsComputations(pc: PC, c1: Computation[Nothing, (StringValues.this)#ExceptionValues], c2: Computation[Nothing, (StringValues.this)#ExceptionValues]): Computation[Nothing, (StringValues.this)#ExceptionValues]

    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
  97. def mergeMultipleExceptionValues(pc: PC, v1s: (StringValues.this)#ExceptionValues, v2s: (StringValues.this)#ExceptionValues): (StringValues.this)#ExceptionValues

    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
  98. def multianewarray(pc: PC, counts: (StringValues.this)#Operands, arrayType: ArrayType): Computation[(StringValues.this)#DomainArrayValue, (StringValues.this)#ExceptionValue]

    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.

  99. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  100. def newarray(pc: PC, count: (StringValues.this)#DomainValue, componentType: FieldType): Computation[(StringValues.this)#DomainValue, (StringValues.this)#ExceptionValue]

    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.

  101. def nextRefId(): (StringValues.this)#RefId

    Returns the next unused time stamp.

    Returns the next unused time stamp.

    Definition Classes
    ReferenceValues
  102. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  103. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  104. final def nullRefId: (StringValues.this)#RefId
    Definition Classes
    ReferenceValues
  105. def origin(value: (StringValues.this)#DomainValue): Iterable[ValueOrigin]

    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
  106. def properties(pc: PC, propertyToString: (AnyRef) ⇒ String = (v) ⇒ v.toString): Option[String]

    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
  107. def providesOriginInformationFor(ct: ComputationalType): Boolean

    Implementers are expected to "abstract override" this method to make it possible to stack several domain implementations which provide origin information.

    Implementers are expected to "abstract override" this method to make it possible to stack several domain implementations which provide origin information.

    Definition Classes
    ReferenceValuesOrigin
  108. def refAreEqual(pc: PC, v1: (StringValues.this)#DomainValue, v2: (StringValues.this)#DomainValue): Answer

    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
  109. def refAreNotEqual(pc: PC, value1: (StringValues.this)#DomainValue, value2: (StringValues.this)#DomainValue): Answer

    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
  110. def refEstablishAreEqual(pc: PC, value1: (StringValues.this)#DomainValue, value2: (StringValues.this)#DomainValue, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  111. def refEstablishAreNotEqual(pc: PC, value1: (StringValues.this)#DomainValue, value2: (StringValues.this)#DomainValue, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  112. def refEstablishIsNonNull(pc: PC, value: (StringValues.this)#DomainValue, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  113. def refEstablishIsNull(pc: PC, value: (StringValues.this)#DomainValue, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  114. def refIsNonNull(pc: PC, value: (StringValues.this)#DomainValue): Answer

    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
  115. final def refIsNull(pc: PC, value: (StringValues.this)#DomainValue): Answer

    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
  116. def refSetUpperTypeBoundOfTopOperand(pc: PC, bound: ReferenceType, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  117. def refTopOperandIsNull(pc: PC, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  118. def refineIsNull(pc: PC, value: (StringValues.this)#DomainValue, isNull: Answer, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)
    Attributes
    protected[this]
    Definition Classes
    ReferenceValues
  119. def returnFromSubroutine(pc: PC, lvIndex: Int): Unit

    pc

    The pc of the ret instruction.

    Definition Classes
    SubroutinesDomain
  120. def saload(pc: PC, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayLoadResult
  121. def sastore(pc: PC, value: (StringValues.this)#DomainValue, index: (StringValues.this)#DomainValue, arrayref: (StringValues.this)#DomainValue): (StringValues.this)#ArrayStoreResult
  122. def schedule(successorPC: PC, abruptSubroutineTerminationCount: Int, worklist: Chain[PC]): Chain[PC]

    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
  123. def summarize(pc: PC, values: Iterable[(StringValues.this)#DomainValue]): (StringValues.this)#DomainValue

    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.

  124. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  125. final def throws(value: (StringValues.this)#ExceptionValue): ThrowsException[(StringValues.this)#ExceptionValue]
    Definition Classes
    ReferenceValuesFactory
  126. def toDomainValue(pc: PC, value: AnyRef): (StringValues.this)#DomainReferenceValue

    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
  127. def toJavaObject(pc: PC, value: (StringValues.this)#DomainValue): Option[AnyRef]

    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.

  128. def toString(): String
    Definition Classes
    AnyRef → Any
  129. def typeOfValue(value: (StringValues.this)#DomainValue): TypeInformation

    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
  130. def updateAfterEvaluation(oldValue: (StringValues.this)#DomainValue, newValue: (StringValues.this)#DomainValue): Unit
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  131. def updateAfterException(oldValue: (StringValues.this)#DomainValue, newValue: (StringValues.this)#DomainValue): Unit
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  132. def updateAfterExecution(oldValue: (StringValues.this)#DomainValue, newValueAfterEvaluation: (StringValues.this)#DomainValue, newValueAfterException: (StringValues.this)#DomainValue): Unit
    Attributes
    protected
    Definition Classes
    PostEvaluationMemoryManagement
  133. def updateMemoryLayout(oldValue: (StringValues.this)#DomainValue, newValue: (StringValues.this)#DomainValue, operands: (StringValues.this)#Operands, locals: (StringValues.this)#Locals): ((StringValues.this)#Operands, (StringValues.this)#Locals)

    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
  134. def upperTypeBound(theValues: UIDSet[(StringValues.this)#DomainSingleOriginReferenceValue]): UIDSet[_ <: ReferenceType]

    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
  135. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  138. object StringValue

Inherited from CoreDomainFunctionality

Inherited from SubroutinesDomain

Inherited from MethodCallsDomain

Inherited from AsDomainValue

Inherited from ReferenceValues

Inherited from Origin

Inherited from TypeLevelReferenceValues

Inherited from AsJavaObject

Inherited from GeneralizedArrayHandling

Inherited from ReferenceValuesDomain

Inherited from ReferenceValuesFactory

Inherited from ExceptionsFactory

Inherited from DefaultDomainValueBinding

Inherited from ValuesDomain

Inherited from AnyRef

Inherited from Any

Ungrouped