AnalysisExecutor

Provides the necessary infrastructure to easily execute a given analysis that generates some analysis result that can be printed on the command line.

To facilitate the usage of this trait several implicit conversions are defined that wrap standard analyses (org.opalj.br.analyses) such that they report results that are reportable.

This class distinguishes between class files belonging to the code base under analysis and those that belong to the libraries. Those belonging to the libraries are loaded using the ClassFileReader for library classes (basically, all method bodies are skipped org.opalj.br.reader.Java8LibraryFramework). The parameter to specify library classes is -libcp=, the parameter to specify the "normal" classpath is -cp=.

Control Flow

The standard parameters are checked.
The analysis is called to let it verify the analysis specific parameters.
The Project is created.
The analyze method of the Analysis is called with the project and the parameters.
The results are printed.

Linear Supertypes

AnyRef, Any

Known Subclasses

DefaultOneStepAnalysis

Abstract Value Members

abstract val analysis: Analysis[URL, ReportableAnalysisResult]

The analysis that will be executed.
The analysis that will be executed.
The analyze method implemented by the analysis will be called after loading all class files and creating a Project. Additionally, all specified (additional) parameters are passed to the analyze method.

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
def analysisSpecificParametersDescription: String

Describes the analysis specific parameters.
Describes the analysis specific parameters. An analysis specific parameter has to start with a dash ("-") and has to contain an equals sign ("=").

Note
The parameter -library= is already predefined (see general documentation).
,
The parameter -cp= is already predefined (see general documentation).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkAnalysisSpecificParameters(parameters: Seq[String]): Traversable[String]

Checks if the (additional) parameters are understood by the analysis.
Checks if the (additional) parameters are understood by the analysis. If an error is found a list of issues is returned and the analysis will not be executed.
This method must be overridden if the analysis defines additional parameters. A method that overrides this method should return the list of issues if it can't validate all arguments. The default behavior is to check that there are no additional parameters.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handleParsingExceptions(project: SomeProject, exceptions: Traversable[Throwable]): Unit

Attributes
protected
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def main(unparsedArgs: Array[String]): Unit
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def printUsage(): Unit

Prints out general information how to use this analysis.
Prints out general information how to use this analysis. Printed whenever the set of specified parameters is not valid.

Attributes
protected
def setupProject(cpFiles: Iterable[File], libcpFiles: Iterable[File]): Project[URL]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package analyses

trait AnalysisExecutor extends AnyRef

Control Flow

Abstract Value Members

abstract val analysis: Analysis[URL, ReportableAnalysisResult]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def analysisSpecificParametersDescription: String

final def asInstanceOf[T0]: T0

def checkAnalysisSpecificParameters(parameters: Seq[String]): Traversable[String]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def handleParsingExceptions(project: SomeProject, exceptions: Traversable[Throwable]): Unit

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def main(unparsedArgs: Array[String]): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def printUsage(): Unit

def setupProject(cpFiles: Iterable[File], libcpFiles: Iterable[File]): Project[URL]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped