Packages

t

org.opalj.fpcf

ComputationSpecification

trait ComputationSpecification[A] extends AnyRef

Specification of the properties and the life-cycle methods of a fixpoint computation (FPC) which are required when computing the correct scheduling order and actually executing the fixpoint computation.

Note

The PropertyStore can be used without using ComputationSpecifications and AnalysisScenarios; both latter classes just provide convenience functionality that ensures that common issues are identified early on/are avoided.

Linear Supertypes
AnyRef, Any
Known Subclasses
SimpleComputationSpecification
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ComputationSpecification
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type InitializationData

    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.

Abstract Value Members

  1. abstract def afterPhaseCompletion(ps: PropertyStore, analysis: A): Unit

    Called after phase completion.

  2. abstract def afterPhaseScheduling(ps: PropertyStore, analysis: A): Unit

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

  3. abstract 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.

  4. abstract 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.

  5. abstract def derivesCollaboratively: Set[PropertyBounds]
  6. abstract def derivesEagerly: Set[PropertyBounds]

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

  7. abstract def derivesLazily: Option[PropertyBounds]

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

  8. abstract 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.

  9. abstract def schedule(ps: PropertyStore, i: InitializationData): A

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

  10. abstract 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.

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. def derives: Iterator[PropertyBounds]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. 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.

  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. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    ComputationSpecification → AnyRef → Any
  18. def toString(ps: PropertyStore): String
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped