Class/Object

org.opalj.ai.domain.l0.DefaultTypeLevelReferenceValues

SObjectValue

Related Docs: object SObjectValue | package DefaultTypeLevelReferenceValues

Permalink

class SObjectValue extends (DefaultTypeLevelReferenceValues.this)#ObjectValue with (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ObjectType]

Attributes
protected
Self Type
(DefaultTypeLevelReferenceValues.this)#SObjectValue with (DefaultTypeLevelReferenceValues.this)#DomainObjectValue
Linear Supertypes
(DefaultTypeLevelReferenceValues.this)#SReferenceValue[ObjectType], (DefaultTypeLevelReferenceValues.this)#ObjectValue, (DefaultTypeLevelReferenceValues.this)#ObjectValue, (DefaultTypeLevelReferenceValues.this)#ReferenceValue, (DefaultTypeLevelReferenceValues.this)#ArrayAbstraction, IsReferenceValue, IsAReferenceValue, TypeInformation, (DefaultTypeLevelReferenceValues.this)#Value, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SObjectValue
  2. SReferenceValue
  3. ObjectValue
  4. ObjectValue
  5. ReferenceValue
  6. ArrayAbstraction
  7. IsReferenceValue
  8. IsAReferenceValue
  9. TypeInformation
  10. Value
  11. AnyRef
  12. Any
Implicitly
  1. by orderingToOrdered
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SObjectValue(theUpperTypeBound: ObjectType)

    Permalink

Value Members

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to ArrowAssoc[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def <(that: (DefaultTypeLevelReferenceValues.this)#SObjectValue): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[(DefaultTypeLevelReferenceValues.this)#SObjectValue] is in scope.
    Definition Classes
    Ordered
  6. def <=(that: (DefaultTypeLevelReferenceValues.this)#SObjectValue): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[(DefaultTypeLevelReferenceValues.this)#SObjectValue] is in scope.
    Definition Classes
    Ordered
  7. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def >(that: (DefaultTypeLevelReferenceValues.this)#SObjectValue): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[(DefaultTypeLevelReferenceValues.this)#SObjectValue] is in scope.
    Definition Classes
    Ordered
  9. def >=(that: (DefaultTypeLevelReferenceValues.this)#SObjectValue): Boolean

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[(DefaultTypeLevelReferenceValues.this)#SObjectValue] is in scope.
    Definition Classes
    Ordered
  10. def abstractsOver(other: (DefaultTypeLevelReferenceValues.this)#DomainValue): Boolean

    Permalink

    Returns true iff the abstract state represented by this value abstracts over the state of the given value.

    Returns true iff the abstract state represented by this value abstracts over the state of the given value. In other words if every possible runtime value represented by the given value is also represented by this value.

    The abstract state generally encompasses every information that would be considered during a join of this value and the other value and that could lead to a StructuralUpdate.

    This method is reflexive, I.e., every value abstracts over itself.

    TheIllegalValue only abstracts over itself.

    Implementation

    The default implementation relies on this domain value's join method.

    Overriding this method is, hence, primarily meaningful for performance reasons.

    Definition Classes
    SObjectValueValue
    See also

    isMorePreciseThan

  11. def adapt(target: TargetDomain, origin: ValueOrigin): (target)#DomainValue

    Permalink

    Adapts this value to the given domain (default: throws a domain exception that adaptation is not supported).

    Adapts this value to the given domain (default: throws a domain exception that adaptation is not supported). This method needs to be overridden by concrete Value classes to support the adaptation for a specific domain.

    Supporting the adapt method is primarily necessary when you want to analyze a method that is called by the currently analyzed method and you need to adapt this domain's values (the actual parameters of the method) to the domain used for analyzing the called method.

    Additionally, the adapt method is OPAL's main mechanism to enable dynamic domain-adaptation. I.e., to make it possible to change the abstract domain at runtime if the analysis time takes too long using a (more) precise domain.

    Definition Classes
    SObjectValueValue
    Note

    The abstract interpretation framework does not use/call this method. This method is solely predefined to facilitate the development of project-wide analyses.

  12. final def asDomainValue(implicit targetDomain: Domain): Domain.DomainReferenceValue

    Permalink

    Returns this reference value as a DomainValue of its original domain.

    Returns this reference value as a DomainValue of its original domain.

    Definition Classes
    ReferenceValueIsAReferenceValue
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. final def asIsAReferenceValue: SObjectValue.this

    Permalink
    Definition Classes
    IsAReferenceValue
  15. def asStructuralUpdate(pc: PC, newUpperTypeBound: UIDSet[ObjectType]): Update[(DefaultTypeLevelReferenceValues.this)#DomainValue]

    Permalink
    Attributes
    protected
    Definition Classes
    ObjectValue
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def compare(that: (DefaultTypeLevelReferenceValues.this)#SObjectValue): Int

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[(DefaultTypeLevelReferenceValues.this)#SObjectValue] is in scope.
    Definition Classes
    Ordered
  18. def compareTo(that: (DefaultTypeLevelReferenceValues.this)#SObjectValue): Int

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method orderingToOrdered in scala.math.Ordered. This conversion will take place only if an implicit value of type Ordering[(DefaultTypeLevelReferenceValues.this)#SObjectValue] is in scope.
    Definition Classes
    Ordered → Comparable
  19. final def computationalType: ComputationalType

    Permalink

    Returns ComputationalTypeReference.

    Returns ComputationalTypeReference.

    Definition Classes
    ReferenceValueValue
  20. def doJoin(pc: PC, other: (DefaultTypeLevelReferenceValues.this)#DomainValue): Update[(DefaultTypeLevelReferenceValues.this)#DomainValue]

    Permalink

    Joins this value and the given value.

    Joins this value and the given value.

    Join is called whenever an instruction is evaluated more than once and, hence, the values found on the paths need to be joined. This method is, however, only called if the two values are two different objects ((this ne value) === true), but both values have the same computational type.

    This basically implements the join operator of complete lattices.

    Example

    For example, joining a DomainValue that represents the integer value 0 with a DomainValue that represents the integer value 1 may return a new DomainValue that precisely captures the range [0..1] or that captures all positive integer values or just some integer value.

    Contract

    this value is always the value that was previously used to perform subsequent computations/analyses. Hence, if this value subsumes the given value, the result has to be either NoUpdate or a MetaInformationUpdate. In case that the given value subsumes this value, the result has to be a StructuralUpdate with the given value as the new value. Hence, this join operation is not commutative. If a new (more abstract) abstract value is created that represents both values the result always has to be a StructuralUpdate. If the result is a StructuralUpdate the framework will continue with the interpretation.

    The termination of the abstract interpretation directly depends on the fact that at some point all (abstract) values are fixed and don't change anymore. Hence, it is important that the type of the update is only a org.opalj.ai.StructuralUpdate if the value has changed in a way relevant for future computations/analyses involving this value. In other words, when two values are joined it has to be ensured that no fall back to a previous value occurs. E.g., if you join the existing integer value 0 and the given value 1 and the result would be 1, then it must be ensured that a subsequent join with the value 0 will not result in the value 0 again.

    Conceptually, the join of an object with itself has to return the object itself. Note, that this is a conceptual requirement as such a call (this.doJoin(..,this)) will not be performed by the abstract interpretation framework; this case is handled by the join method. However, if the join object is also used by the implementation of the domain itself, it may be necessary to explicitly handle self-joins.

    Performance

    In general, the domain should try to minimize the number of objects that it uses to represent values. That is, two values that are conceptually equal should – whenever possible – use only one object. This has a significant impact on functions such as join.

    pc

    The program counter of the instruction where the paths converge.

    Attributes
    protected
    Definition Classes
    SObjectValueValue
  21. def ensuring(cond: ((DefaultTypeLevelReferenceValues.this)#SObjectValue) ⇒ Boolean, msg: ⇒ Any): (DefaultTypeLevelReferenceValues.this)#SObjectValue

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  32. def isMorePreciseThan(other: (DefaultTypeLevelReferenceValues.this)#DomainValue): Boolean

    Permalink

    Returns true iff the abstract state represented by this value is striclty more precise than the state of the given value.

    Returns true iff the abstract state represented by this value is striclty more precise than the state of the given value. In other words if every possible runtime value represented by this value is also represented by the given value, but both are not equal; in other words, this method is irreflexive.

    The considered abstract state generally encompasses every information that would be considered during a join of this value and the other value and that could lead to a StructuralUpdate.

    other

    Another DomainValue with the same computational type as this value. (The IllegalValue has no computational type and, hence, a comparison with an IllegalValue is not well defined.)

    Definition Classes
    Value
    Note

    It is recommended to overwrite this method for performance reasons, as the default implementation relies on join.

    See also

    abstractsOver

  33. def isNull: Answer

    Permalink

    If Yes the value is known to always be null at runtime.

    If Yes the value is known to always be null at runtime. In this case the upper bound is (has to be) empty. If the answer is Unknown then the analysis was not able to statically determine whether the value is null or is not null. In this case the upper bound is expected to be non-empty. If the answer is No then the value is statically known not to be null. In this case, the upper bound may precisely identify the runtime type or still just identify an upper bound.

    This default implementation always returns Unknown; this is a sound over-approximation.

    returns

    Unknown.

    Definition Classes
    IsAReferenceValue
    Note

    This method is expected to be overridden by subtypes.

  34. def isPrecise: Boolean

    Permalink

    Returns true if the type information is precise.

    Returns true if the type information is precise. I.e., the type returned by upperTypeBound precisely models the runtime type of the value. If, isPrecise returns true, the type of this value can generally be assumed to represent a class type (not an interface type) or an array type. However, this domain also supports the case that isPrecise returns true even though the associated type identifies an interface type or an abstract class type. The later case may be interesting in the context of classes that are generated at run time.

    This default implementation always returns false.

    returns

    false

    Definition Classes
    ReferenceValueIsAReferenceValue
    Note

    This method is expected to be overridden by subtypes.

    ,

    isPrecise is always true if this value is known to be null.

  35. final def isPrimitiveValue: Boolean

    Permalink
    Definition Classes
    IsReferenceValueTypeInformation
  36. final def isReferenceValue: Boolean

    Permalink
    Definition Classes
    IsReferenceValueTypeInformation
  37. def isValueSubtypeOf(supertype: ReferenceType): Answer

    Permalink

    Tests if the type of this value is potentially a subtype of the specified reference type under the assumption that this value is not null.

    Tests if the type of this value is potentially a subtype of the specified reference type under the assumption that this value is not null. This test takes the precision of the type information into account. That is, if the currently available type information is not precise and the given type has a subtype that is always a subtype of the current upper type bound, then Unknown is returned. Given that it may be computationally intensive to determine whether two types have a common subtype it may be better to just return Unknown in case that this type and the given type are not in a direct inheritance relationship.

    Basically, this method implements the same semantics as the ClassHierarchy's isSubtypeOf method, but it additionally checks if the type of this value could be a subtype of the given supertype. I.e., if this value's type identifies a supertype of the given supertype and that type is not known to be precise, the answer is Unknown.

    For example, assume that the type of this reference value is java.util.Collection and we know/have to assume that this is only an upper bound. In this case an answer is No if and only if it is impossible that the runtime type is a subtype of the given supertype. This condition holds, for example, for java.io.File which is not a subclass of java.util.Collection and which does not have any further subclasses (in the JDK). I.e., the classes java.io.File and java.util.Collection are not in an inheritance relationship. However, if the specified supertype would be java.util.List the answer would be unknown.

    returns

    This default implementation always returns Unknown.

    Definition Classes
    SObjectValueIsAReferenceValue
    Note

    It is often not necessary to override this method as this method already takes the property whether the upper type bound is precise into account.

  38. def join(pc: PC, that: (DefaultTypeLevelReferenceValues.this)#DomainValue): Update[(DefaultTypeLevelReferenceValues.this)#DomainValue]

    Permalink

    Checks that the given value and this value are compatible with regard to its computational type and – if so – calls doJoin.

    Checks that the given value and this value are compatible with regard to its computational type and – if so – calls doJoin.

    See doJoin(PC,DomainValue) for details.

    pc

    The program counter of the instruction where the paths converge.

    that

    The "new" domain value with which this domain value should be joined. The caller has to ensure that the given value and this value are guaranteed to be two different objects.

    returns

    MetaInformationUpdateIllegalValue or the result of calling doJoin.

    Definition Classes
    Value
    Note

    It is in general not recommended/needed to override this method.

  39. final def length(pc: PC): Computation[(DefaultTypeLevelReferenceValues.this)#DomainValue, (DefaultTypeLevelReferenceValues.this)#ExceptionValue]

    Permalink
    Definition Classes
    ObjectValueArrayAbstraction
  40. final def load(pc: PC, index: (DefaultTypeLevelReferenceValues.this)#DomainValue): (DefaultTypeLevelReferenceValues.this)#ArrayLoadResult

    Permalink
    Definition Classes
    ObjectValueArrayAbstraction
  41. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  44. final def referenceValues: Iterable[IsAReferenceValue]

    Permalink
    Definition Classes
    SReferenceValue
  45. final def store(pc: PC, value: (DefaultTypeLevelReferenceValues.this)#DomainValue, index: (DefaultTypeLevelReferenceValues.this)#DomainValue): (DefaultTypeLevelReferenceValues.this)#ArrayStoreResult

    Permalink
    Definition Classes
    ObjectValueArrayAbstraction
  46. final def summarize(pc: PC): SObjectValue.this

    Permalink
    Definition Classes
    SReferenceValue
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  48. val theUpperTypeBound: ObjectType

    Permalink
    Definition Classes
    SObjectValueSReferenceValue
  49. def toString(): String

    Permalink
    Definition Classes
    SReferenceValue → AnyRef → Any
  50. final def unknown: Boolean

    Permalink

    Returns true if no type information is available.

    Returns true if no type information is available.

    Definition Classes
    IsReferenceValueTypeInformation
  51. final def upperTypeBound: UpperTypeBound

    Permalink
    Definition Classes
    SReferenceValue
  52. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def [B](y: B): ((DefaultTypeLevelReferenceValues.this)#SObjectValue, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from (DefaultTypeLevelReferenceValues.this)#SObjectValue to ArrowAssoc[(DefaultTypeLevelReferenceValues.this)#SObjectValue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from (DefaultTypeLevelReferenceValues.this)#SReferenceValue[ObjectType]

Inherited from (DefaultTypeLevelReferenceValues.this)#ObjectValue

Inherited from (DefaultTypeLevelReferenceValues.this)#ObjectValue

Inherited from (DefaultTypeLevelReferenceValues.this)#ReferenceValue

Inherited from (DefaultTypeLevelReferenceValues.this)#ArrayAbstraction

Inherited from IsReferenceValue

Inherited from IsAReferenceValue

Inherited from TypeInformation

Inherited from (DefaultTypeLevelReferenceValues.this)#Value

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion orderingToOrdered from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ordered[(DefaultTypeLevelReferenceValues.this)#SObjectValue]

Inherited by implicit conversion any2stringadd from (DefaultTypeLevelReferenceValues.this)#SObjectValue to any2stringadd[(DefaultTypeLevelReferenceValues.this)#SObjectValue]

Inherited by implicit conversion StringFormat from (DefaultTypeLevelReferenceValues.this)#SObjectValue to StringFormat[(DefaultTypeLevelReferenceValues.this)#SObjectValue]

Inherited by implicit conversion Ensuring from (DefaultTypeLevelReferenceValues.this)#SObjectValue to Ensuring[(DefaultTypeLevelReferenceValues.this)#SObjectValue]

Inherited by implicit conversion ArrowAssoc from (DefaultTypeLevelReferenceValues.this)#SObjectValue to ArrowAssoc[(DefaultTypeLevelReferenceValues.this)#SObjectValue]

Ungrouped