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 br

    In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries.

    In this representation of Java bytecode references to a Java class file's constant pool and to attributes are replaced by direct references to the corresponding constant pool entries. This facilitates developing analyses and fosters comprehension.

    Based on the fact that indirect references to constant pool entries are resolved and replaced by direct references this representation is called the resolved representation.

    This representation of Java bytecode is considered as OPAL's standard representation for writing Scala based analyses. This representation is engineered such that it facilitates writing analyses that use pattern matching.

    Definition Classes
    opalj
  • package fpcf
    Definition Classes
    br
  • package analyses
    Definition Classes
    fpcf
  • package properties
    Definition Classes
    fpcf
  • BasicFPCFEagerAnalysisScheduler
  • BasicFPCFLazyAnalysisScheduler
  • BasicFPCFTransformerScheduler
  • BasicFPCFTriggeredAnalysisScheduler
  • DefaultFPCFAnalysis
  • FPCFAnalysesManager
  • FPCFAnalysesManagerKey
  • FPCFAnalysesRegistry
  • FPCFAnalysis
  • FPCFAnalysisScheduler
  • FPCFEagerAnalysisScheduler
  • FPCFLazyAnalysisScheduler
  • FPCFLazyLikeAnalysisScheduler
  • FPCFTransformerScheduler
  • FPCFTriggeredAnalysisScheduler
  • PropertyStoreKey
t

org.opalj.br.fpcf

BasicFPCFTransformerScheduler

trait BasicFPCFTransformerScheduler extends FPCFTransformerScheduler

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BasicFPCFTransformerScheduler
  2. FPCFTransformerScheduler
  3. FPCFLazyLikeAnalysisScheduler
  4. FPCFAnalysisScheduler
  5. ComputationSpecification
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type InitializationData = Null

    The type of the data used by the analysis at initialization time.

    The type of the data used by the analysis at initialization time. For analyses without special initialization requirements this type is Null.

    Definition Classes
    BasicFPCFTransformerScheduler → ComputationSpecification

Abstract Value Members

  1. abstract def derivesLazily: Some[PropertyBounds]

    Returns the kind of the property that is lazily (on-demand) derived.

    Returns the kind of the property that is lazily (on-demand) derived.

    Definition Classes
    FPCFLazyLikeAnalysisScheduler → ComputationSpecification
  2. abstract def register(project: SomeProject, propertyStore: PropertyStore, i: InitializationData): FPCFAnalysis

    Called when a schedule is executed and when this analysis shall register itself with the property store using org.opalj.fpcf.PropertyStore.registerLazyPropertyComputation or org.opalj.fpcf.PropertyStore.registerTransformer method.

    Called when a schedule is executed and when this analysis shall register itself with the property store using org.opalj.fpcf.PropertyStore.registerLazyPropertyComputation or org.opalj.fpcf.PropertyStore.registerTransformer method.

    This method is typically called by the org.opalj.br.fpcf.FPCFAnalysesManager.

    Definition Classes
    FPCFLazyLikeAnalysisScheduler
    Note

    This analysis must not call registerTriggeredComputation or a variant of scheduleEagerComputationForEntity.

  3. abstract def requiredProjectInformation: ProjectInformationKeys

    Returns all org.opalj.br.analyses.ProjectInformationKeys required by the analyses.

    Returns all org.opalj.br.analyses.ProjectInformationKeys required by the analyses.

    This information is in particular required by keys which - when the key is computed - make use of other keys which are not statically known at compile time. If a single key that is (transitively) used is not correctly listed, a deadlock will _always_ occur.

    Definition Classes
    FPCFAnalysisScheduler
  4. abstract def uses: Set[PropertyBounds]

    The uses that are configuration independent.

    The uses that are configuration independent.

    Definition Classes
    FPCFAnalysisScheduler

Concrete 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. def afterPhaseCompletion(p: SomeProject, ps: PropertyStore, analysis: FPCFAnalysis): Unit
    Definition Classes
    BasicFPCFTransformerScheduler → FPCFAnalysisScheduler
  5. final def afterPhaseCompletion(ps: PropertyStore, analysis: FPCFAnalysis): Unit

    Called after phase completion.

    Called after phase completion.

    Definition Classes
    FPCFAnalysisScheduler → ComputationSpecification
  6. def afterPhaseScheduling(ps: PropertyStore, analysis: FPCFAnalysis): Unit

    Called back after all analyses of a specific phase have been schedule (i.e., before calling waitOnPhaseCompletion).

    Called back after all analyses of a specific phase have been schedule (i.e., before calling waitOnPhaseCompletion).

    Definition Classes
    BasicFPCFTransformerScheduler → ComputationSpecification
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def beforeSchedule(p: SomeProject, ps: PropertyStore): Unit
    Definition Classes
    BasicFPCFTransformerScheduler → FPCFAnalysisScheduler
  9. final def beforeSchedule(ps: PropertyStore): Unit

    Called directly before the analyses belonging to a phase are effectively scheduled.

    Called directly before the analyses belonging to a phase are effectively scheduled. I.e., after phase setup, but potentially after other analyses' beforeSchedule method is called.

    Definition Classes
    FPCFAnalysisScheduler → ComputationSpecification
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. final def computationType: ComputationType

    Specifies the kind of the computation that is performed.

    Specifies the kind of the computation that is performed. The kind restricts in which way the analysis is allowed to interact with the property store/other analyses.

    Definition Classes
    FPCFTransformerScheduler → ComputationSpecification
  12. def derives: Iterator[PropertyBounds]
    Definition Classes
    ComputationSpecification
  13. final def derivesCollaboratively: Set[PropertyBounds]
    Definition Classes
    FPCFLazyLikeAnalysisScheduler → ComputationSpecification
  14. final def derivesEagerly: Set[PropertyBounds]

    Returns the set of property kinds eagerly derived by the underlying analysis.

    Returns the set of property kinds eagerly derived by the underlying analysis.

    Definition Classes
    FPCFLazyLikeAnalysisScheduler → ComputationSpecification
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. def init(p: SomeProject, ps: PropertyStore): Null
    Definition Classes
    BasicFPCFTransformerScheduler → FPCFAnalysisScheduler
  20. final def init(ps: PropertyStore): InitializationData

    Called directly after the analysis is registered with an analysis scheduler; in particular before any analysis belonging to the same analysis scenario is scheduled – independent of the batch in which it will run.

    Called directly after the analysis is registered with an analysis scheduler; in particular before any analysis belonging to the same analysis scenario is scheduled – independent of the batch in which it will run.

    This enables further initialization of the computations that will eventually be executed. For example to initialize global configuration information.

    A computation specification does not have to call any methods of the property store that may trigger or schedule computations; i.e., it must – in particular – not call the methods apply, schedule*, register* or waitOnPhaseCompletion.

    returns

    The initialization data that is later on passed to schedule.

    Definition Classes
    FPCFAnalysisScheduler → ComputationSpecification
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def name: String

    Identifies this computation specification; typically the name of the class which implements the underlying analysis.

    Identifies this computation specification; typically the name of the class which implements the underlying analysis.

    The default name is the name of this class.

    This method should be overridden.

    Definition Classes
    ComputationSpecification
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def register(project: SomeProject, i: InitializationData): FPCFAnalysis
    Definition Classes
    FPCFLazyLikeAnalysisScheduler
  27. final def schedule(ps: PropertyStore, i: InitializationData): FPCFAnalysis

    Called by the scheduler to let the analysis register itself or to start execution.

    Called by the scheduler to let the analysis register itself or to start execution.

    Definition Classes
    FPCFLazyLikeAnalysisScheduler → ComputationSpecification
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    ComputationSpecification → AnyRef → Any
  30. def toString(ps: PropertyStore): String
    Definition Classes
    ComputationSpecification
  31. final val uniqueId: Int

    The unique id of this factory.

    The unique id of this factory.

    Every factory for a specific analysis is automatically associated with a unique id.

    Definition Classes
    FPCFAnalysisScheduler
  32. def uses(p: SomeProject, ps: PropertyStore): Set[PropertyBounds]

    The uses that are configuration (project) dependent.

    The uses that are configuration (project) dependent.

    Definition Classes
    FPCFAnalysisScheduler
  33. final def uses(ps: PropertyStore): Set[PropertyBounds]

    Returns the kinds of properties which are queried by this analysis.

    Returns the kinds of properties which are queried by this analysis.

    Definition Classes
    FPCFAnalysisScheduler → ComputationSpecification
    Note

    This set consists only of property kinds which are directly used by the analysis.

    ,

    Self usages should also be documented.

    ,

    This method is called after org.opalj.fpcf.ComputationSpecification#init(ps:org\.opalj\.fpcf\.PropertyStore)* was called for all analyses belonging to an analysis scenario. (E.g., it can be used to collect the set of used property bounds based on the configuration choices made in other analyses.)

  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. 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 FPCFTransformerScheduler

Inherited from FPCFLazyLikeAnalysisScheduler

Inherited from FPCFAnalysisScheduler

Inherited from ComputationSpecification[FPCFAnalysis]

Inherited from AnyRef

Inherited from Any

Ungrouped