trait FPCFAnalysisScheduler extends ComputationSpecification[FPCFAnalysis]
Specification of the properties of an analysis.
- Source
- FPCFAnalysisScheduler.scala
- Note
It is possible to use an analysis that directly uses the property store and an analysis that uses this factory infrastructure at the same time.
- Alphabetic
- By Inheritance
- FPCFAnalysisScheduler
- ComputationSpecification
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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
.- Definition Classes
- ComputationSpecification
Abstract Value Members
- abstract def afterPhaseCompletion(p: SomeProject, ps: PropertyStore, analysis: FPCFAnalysis): Unit
- abstract 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
- ComputationSpecification
- abstract def beforeSchedule(p: SomeProject, ps: PropertyStore): Unit
- 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.
- Definition Classes
- ComputationSpecification
- abstract def derivesCollaboratively: Set[PropertyBounds]
- Definition Classes
- ComputationSpecification
- abstract 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
- ComputationSpecification
- abstract def derivesLazily: Option[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
- ComputationSpecification
- abstract def init(p: SomeProject, ps: PropertyStore): InitializationData
- 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.
- abstract 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
- ComputationSpecification
- abstract def uses: Set[PropertyBounds]
The uses that are configuration independent.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def afterPhaseCompletion(ps: PropertyStore, analysis: FPCFAnalysis): Unit
Called after phase completion.
Called after phase completion.
- Definition Classes
- FPCFAnalysisScheduler → ComputationSpecification
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def derives: Iterator[PropertyBounds]
- Definition Classes
- ComputationSpecification
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- 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*
orwaitOnPhaseCompletion
.- returns
The initialization data that is later on passed to schedule.
- Definition Classes
- FPCFAnalysisScheduler → ComputationSpecification
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ComputationSpecification → AnyRef → Any
- def toString(ps: PropertyStore): String
- Definition Classes
- ComputationSpecification
- 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.
- def uses(p: SomeProject, ps: PropertyStore): Set[PropertyBounds]
The uses that are configuration (project) dependent.
- 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.)
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated