object FinalizerAnalysisScheduler extends BasicFPCFTriggeredAnalysisScheduler
- Source
- FinalizerAnalysis.scala
- Alphabetic
- By Inheritance
- FinalizerAnalysisScheduler
- BasicFPCFTriggeredAnalysisScheduler
- FPCFTriggeredAnalysisScheduler
- FPCFAnalysisScheduler
- ComputationSpecification
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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
- BasicFPCFTriggeredAnalysisScheduler → ComputationSpecification
Value Members
- def afterPhaseCompletion(p: SomeProject, ps: PropertyStore, analysis: FPCFAnalysis): Unit
- Definition Classes
- BasicFPCFTriggeredAnalysisScheduler → FPCFAnalysisScheduler
- final def afterPhaseCompletion(ps: PropertyStore, analysis: FPCFAnalysis): Unit
Called after phase completion.
Called after phase completion.
- Definition Classes
- FPCFAnalysisScheduler → ComputationSpecification
- 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
- BasicFPCFTriggeredAnalysisScheduler → ComputationSpecification
- def beforeSchedule(p: SomeProject, ps: PropertyStore): Unit
- Definition Classes
- BasicFPCFTriggeredAnalysisScheduler → FPCFAnalysisScheduler
- 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'
beforeSchedulemethod is called.- Definition Classes
- FPCFAnalysisScheduler → ComputationSpecification
- 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
- FPCFTriggeredAnalysisScheduler → ComputationSpecification
- def derives: Iterator[PropertyBounds]
- Definition Classes
- ComputationSpecification
- def derivesCollaboratively: Set[PropertyBounds]
- Definition Classes
- FinalizerAnalysisScheduler → ComputationSpecification
- 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
- FinalizerAnalysisScheduler → ComputationSpecification
- final 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
- FPCFTriggeredAnalysisScheduler → ComputationSpecification
- def init(p: SomeProject, ps: PropertyStore): Null
- Definition Classes
- BasicFPCFTriggeredAnalysisScheduler → FPCFAnalysisScheduler
- 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
- 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
thisclass.This method should be overridden.
- Definition Classes
- ComputationSpecification
- def register(p: SomeProject, ps: PropertyStore, unused: Null): FinalizerAnalysis
Called when a schedule is executed and when this analysis shall register itself with the property store using org.opalj.fpcf.PropertyStore#registerTriggeredComputation.
Called when a schedule is executed and when this analysis shall register itself with the property store using org.opalj.fpcf.PropertyStore#registerTriggeredComputation. This method is typically called by the org.opalj.br.fpcf.FPCFAnalysesManager.
- Definition Classes
- FinalizerAnalysisScheduler → FPCFTriggeredAnalysisScheduler
- Note
This analysis must not call
registerLazyPropertyComputationor a variant ofscheduleEagerComputationForEntity.
- final def register(project: SomeProject, i: InitializationData): FPCFAnalysis
- Definition Classes
- FPCFTriggeredAnalysisScheduler
- 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
- FinalizerAnalysisScheduler → FPCFAnalysisScheduler
- 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
- FPCFTriggeredAnalysisScheduler → ComputationSpecification
- def toString(): String
- Definition Classes
- ComputationSpecification → AnyRef → Any
- def toString(ps: PropertyStore): String
- Definition Classes
- ComputationSpecification
- def triggeredBy: PropertyKind
Specifies the kind of the properties that will trigger the analysis to be registered.
Specifies the kind of the properties that will trigger the analysis to be registered.
- Definition Classes
- FinalizerAnalysisScheduler → FPCFTriggeredAnalysisScheduler
- 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
- def uses: Set[PropertyBounds]
The uses that are configuration independent.
The uses that are configuration independent.
- Definition Classes
- FinalizerAnalysisScheduler → FPCFAnalysisScheduler
- 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
- 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.)