de.tud.cs.peaks.osgi.framework.api

Class AbstractAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>

java.lang.Object

de.tud.cs.peaks.osgi.framework.api.AbstractAnalysisService<Result,Config>

Type Parameters:

Result - The type of the IAnalysisResult this AnalysisService produces.

Config - The type of the IAnalysisConfig this AnalysisService uses.

All Implemented Interfaces:

IAnalysisService<Result,Config>

public abstract class AbstractAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>
extends Object
implements IAnalysisService<Result,Config>

An abstract class for AnalysisServices. Concrete implementations MUST declare an DependsOn annotation indicating on which analyses the service depends on. This class provides automatic methods to run depending analyses and to cache the results.

Author:

Florian Kuebler, Patrick Mueller

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAnalysisService(org.osgi.framework.BundleContext context) Constructor of the AnalysisService.

Method Summary

Modifier and Type	Method and Description
org.osgi.framework.Bundle	getBundle() The Bundle which this AnalysisService belongs to.
protected abstract List<Class<? extends AbstractAnalysisService<? extends IAnalysisResult,? extends IAnalysisConfig>>>	getDependOnAnalyses()
Future<Result>	performAnalysis(Config config) Performs the analysis with the given config, running all required other analyses This is implemented by AbstractAnalysisService
boolean	shouldBeHidden() Method the framework uses to decide whether this service should be hidden from the user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.tud.cs.peaks.osgi.framework.api.IAnalysisService

convertConfig, getName, parseConfig, runAnalysis

Constructor Detail

AbstractAnalysisService

protected AbstractAnalysisService(org.osgi.framework.BundleContext context)

Constructor of the AnalysisService.

Parameters:

context - the context of the bundle this service belongs to.

Method Detail

performAnalysis

public final Future<Result> performAnalysis(Config config)

Performs the analysis with the given config, running all required other analyses This is implemented by AbstractAnalysisService

Specified by:

performAnalysis in interface IAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>

Parameters:

config - the given config

Returns:

a future which will contain the analysis result

See Also:

DependsOn, AbstractAnalysisService

getBundle

public org.osgi.framework.Bundle getBundle()

The Bundle which this AnalysisService belongs to.

Specified by:

getBundle in interface IAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>

Returns:

the corresponding OSGi Bundle

shouldBeHidden

public boolean shouldBeHidden()

Description copied from interface: IAnalysisService

Method the framework uses to decide whether this service should be hidden from the user

Specified by:

shouldBeHidden in interface IAnalysisService<Result extends IAnalysisResult,Config extends IAnalysisConfig>

Returns:

whether this service should be hidden from the user

getDependOnAnalyses

protected abstract List<Class<? extends AbstractAnalysisService<? extends IAnalysisResult,? extends IAnalysisConfig>>> getDependOnAnalyses()

Returns:

the list of all AnalysisServices this service depends on.