DefaultOneStepAnalysis

Instance Constructors

new DefaultOneStepAnalysis()

Abstract Value Members

abstract def doAnalyze(project: Project[URL], parameters: Seq[String] = List.empty, isInterrupted: () ⇒ Boolean): BasicReport

Definition Classes
OneStepAnalysis

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 val analysis: DefaultOneStepAnalysis

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.

Definition Classes
DefaultOneStepAnalysis → AnalysisExecutor
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 ("=").

Definition Classes
AnalysisExecutor
Note
The parameter -library= is already predefined (see general documentation).
,
The parameter -cp= is already predefined (see general documentation).
final def analyze(project: Project[URL], parameters: Seq[String] = List.empty, initProgressManagement: (Int) ⇒ ProgressManagement = ProgressManagement.None): BasicReport

Analyzes the given project and reports the result(s).
Analyzes the given project and reports the result(s).
initProgressManagement
A function to get a org.opalj.br.analyses.ProgressManagement object. The function is called by the analysis for each major analysis with the number of steps (Int) that will be performed . The analysis will subsequently use that object to report status information (related to that part of the analysis) and to check the interrupted status. The number of steps is at least 1. The analysis may call this function multiple times. However, the last End event always has be signaled using the first ProgressManagement object. In other words, logically nested calls are supported, but chaining is not. A legal call sequence could be:
```
val pouter = initProgressManagement(2)
pouter.progress(1,Start,Some("call graph analysis"))
    // ... construct call graph
pouter.progress(1,End,None)
pouter.progress(2,Start,Some("analyzing class files"))
    val p2 = initProgressManagement(500)
    // SEVERAL CLASS FILES ARE ANALYZED IN PARALLEL:
    p2.progress(1,Start,Some("java.lang.Object"))
    p2.progress(2,Start,Some("java.util.ArrayList"))
    p2.progress(3,Start,Some("java.lang.String"))
    p2.progress(2,End,Some("java.util.ArrayList"))
    p2.progress(4,Start,Some("java.util.Date"))
    ...
    p2.progress(500,End,None)
pouter.progress(2,End,None)
```
returns
The analysis' result. If the analysis was aborted/killed the analysis should return an appropriate result (which might be null) and this has to be specified/documented by the analysis.
Definition Classes
OneStepAnalysis → Analysis
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.

Definition Classes
AnalysisExecutor
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copyright: String

The copyright statement which contains less than 124 character and no line-breaks.
The copyright statement which contains less than 124 character and no line-breaks.

Definition Classes
Analysis
def description: String

A textual description of this analysis.
A textual description of this analysis.
The description should discuss:
- the goal of the analysis
- weaknesses of the analysis; i.e., whether the analysis may report false positives or may not report existing bugs (i.e., whether the analysis is subject to false negatives.)
- if applicable, it should discuss what the developer could/should do in general to remedy the situation
- if applicable it should discuss the severeness of the found results. I.e., whether immediate action is required because a bug was found that will show up at runtime or if it is a security bug.
- if applicable it should give an example. I.e., what the expected result is given a project with certain resources.
Definition Classes
Analysis
def documentationUrl: Option[String]

A URL at which documentation about this analysis can be found.
A URL at which documentation about this analysis can be found. This allows user interfaces to show a link for the user to click on, as a way to access further documentation about this analysis.
For example, for a command line interface, outputting the entire description to the console may not be desirable, and it could show this URL instead.
This is just a String, not a java.net.URL, because we do not intend to use it as an URL internally. It is just a text string that can be shown to the user.

Definition Classes
Analysis
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
Definition Classes
AnalysisExecutor
def hashCode(): Int

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

Definition Classes
Any
def main(unparsedArgs: Array[String]): Unit

Definition Classes
AnalysisExecutor
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
Definition Classes
AnalysisExecutor
def setupProject(cpFiles: Iterable[File], libcpFiles: Iterable[File]): Project[URL]

Definition Classes
AnalysisExecutor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def title: String

A short descriptive title which should contain less than 64 characters and no line-breaks.
A short descriptive title which should contain less than 64 characters and no line-breaks.
The default is the simple name of the class implementing the analysis.

Definition Classes
Analysis
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

abstract class DefaultOneStepAnalysis extends AnalysisExecutor with OneStepAnalysis[URL, BasicReport]

Instance Constructors

new DefaultOneStepAnalysis()

Abstract Value Members

abstract def doAnalyze(project: Project[URL], parameters: Seq[String] = List.empty, isInterrupted: () ⇒ Boolean): BasicReport

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final val analysis: DefaultOneStepAnalysis

def analysisSpecificParametersDescription: String

final def analyze(project: Project[URL], parameters: Seq[String] = List.empty, initProgressManagement: (Int) ⇒ ProgressManagement = ProgressManagement.None): BasicReport

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

def copyright: String

def description: String

def documentationUrl: Option[String]

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 title: String

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from OneStepAnalysis[URL, BasicReport]

Inherited from Analysis[URL, BasicReport]

Inherited from AnalysisExecutor

Inherited from AnyRef

Inherited from Any

Ungrouped