Trait/Object

org.opalj.ai

IsReferenceValue

Related Docs: object IsReferenceValue | package ai

Permalink

trait IsReferenceValue extends TypeInformation with IsAReferenceValue

The value identifies one or more reference values. Additionally, it is possible to get a representation that represents a summary of all underlying reference values.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IsReferenceValue
  2. IsAReferenceValue
  3. TypeInformation
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def asDomainValue(implicit domain: 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.

    domain

    The domain that was used to create this object can be used to get/create a DomainValue.

    Definition Classes
    IsAReferenceValue
    Annotations
    @throws( ... )
  2. abstract def referenceValues: Traversable[IsAReferenceValue]

    Permalink

    In general a domain value can represent several distinct values (depending on the control flow).

    In general a domain value can represent several distinct values (depending on the control flow).

    Each of these values can have a different upper bound and an upper bound can in turn consist of several interfaces and a class.

  3. abstract def upperTypeBound: UIDSet[_ <: ReferenceType]

    Permalink

    The upper bound of the value's type.

    The upper bound of the value's type. The upper bound is empty if this value is null (i.e., isNull == Yes). The upper bound is only guaranteed to contain exactly one type if the type is precise. (i.e., isPrecise == true). Otherwise, the upper type bound may contain one or more types that are not known to be in an inheritance relation, but which will correctly approximate the runtime type.

    Definition Classes
    IsAReferenceValue
    Note

    If only a part of a project is analyzed, the class hierarchy may be fragmented and it may happen that two classes that are indeed in an inheritance relation – if we would analyze the complete project – are part of the upper type bound.

Concrete Value Members

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. final def asIsAReferenceValue: IsReferenceValue.this.type

    Permalink
    Definition Classes
    IsAReferenceValue
  8. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  20. 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.

  21. 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
    IsAReferenceValue
    Note

    This method is expected to be overridden by subtypes.

    ,

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

  22. final def isPrimitiveValue: Boolean

    Permalink
    Definition Classes
    IsReferenceValueTypeInformation
  23. final def isReferenceValue: Boolean

    Permalink
    Definition Classes
    IsReferenceValueTypeInformation
  24. def isValueSubtypeOf(referenceType: 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
    IsAReferenceValue
    Annotations
    @throws( ... )
    Note

    This method is expected to be overridden by subtypes.

    ,

    The function isValueSubtypeOf is not defined if isNull returns Yes; if isNull is Unknown then the result is given under the assumption that the value is not null at runtime. In other words, if this value represents null this method is not supported.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

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

    Permalink

    Returns true if no type information is available.

    Returns true if no type information is available.

    Definition Classes
    IsReferenceValueTypeInformation
  31. final def wait(): Unit

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

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

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

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

Inherited from IsAReferenceValue

Inherited from TypeInformation

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped