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 implementing lattice based static analyses (Static Analysis Infrastructure)
    • 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 (Bytecode Assembler).

    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.

    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.AI - Implements the abstract interpreter that processes a methods code and uses an analysis-specific domain to perform the abstract computations.

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

  • package fpcf
    Definition Classes
    ai
  • package properties
    Definition Classes
    fpcf
  • AIDomainFactoryKey
  • AnAIResult
  • BaseAIResult
  • BaseAIResultPropertyMetaInformation
  • FieldValue
  • FieldValueMetaInformation
  • MethodReturnValue
  • MethodReturnValuePropertyMetaInformation
  • NoAIResult
  • NoMethodReturnValue
  • ProjectSpecificAIExecutor
  • TheMethodReturnValue
  • TypeBasedFieldValueInformation
  • ValueBasedFieldValueInformation
o

org.opalj.ai.fpcf.properties

AIDomainFactoryKey

object AIDomainFactoryKey extends ProjectInformationKey[ProjectSpecificAIExecutor, Set[Class[_ <: AnyRef]]]

Key to get the factory (actually this is a meta-factory) to create the domains that are used to perform abstract interpretations. The domain that is going to be used is determined by getting the set of (partial)domains that are required and then computing the cheapest domain; see org.opalj.ai.common.DomainRegistry for further information. Hence, the AIResult's domain is guaranteed to implement all required (partial) domains.

This key's project specific initialization data are java.lang.Class objects which have to be implemented by the finally chosen domain.

Source
AIDomainFactoryKey.scala
Linear Supertypes
ProjectInformationKey[ProjectSpecificAIExecutor, Set[Class[_ <: AnyRef]]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AIDomainFactoryKey
  2. ProjectInformationKey
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def compute(project: SomeProject, domainFactories: (Iterable[Class[_ <: AnyRef]]) => Set[Class[_ <: Domain]]): ProjectSpecificAIExecutor
  7. def compute(project: SomeProject): ProjectSpecificAIExecutor

    Returns an object which performs and caches the result of the abstract interpretation of a method when required.

    Returns an object which performs and caches the result of the abstract interpretation of a method when required.

    All methods belonging to a project are analyzed using the same domainFactory. Hence, the domainFactory needs to be set before compute is called/this key is passed to a specific project. If multiple projects are instead concurrently, external synchronization is necessary (e.g., on the ProjectInformationKey) to ensure that each project is instantiated using the desired domain.

    Definition Classes
    AIDomainFactoryKeyProjectInformationKey
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. def requirements(project: SomeProject): Seq[ProjectInformationKey[Nothing, Nothing]]

    This key has no special prerequisites.

    This key has no special prerequisites.

    Definition Classes
    AIDomainFactoryKeyProjectInformationKey
    Note

    The configuration is done using ProjectInformationKeyInitializationData.

  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final val uniqueId: Int

    The unique id of this key.

    The unique id of this key. The key is used to enable efficient access and is automatically assigned by OPAL and will not change after that.

    Definition Classes
    ProjectInformationKey
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ProjectInformationKey[ProjectSpecificAIExecutor, Set[Class[_ <: AnyRef]]]

Inherited from AnyRef

Inherited from Any

Ungrouped