Packages

trait Analysis[Source, +AnalysisResult] extends AnyRef

Common trait that analyses can inherit from when they want to use the general analysis framework AnalysisExecutor.

Conceptual Idea

An analysis is basically a mapping of a Project's resources to some result.

Each analysis can produce (optionally) some result. E.g., a text describing a scenario that leads to a bug, a graph, a report that identifies a specific line or a combination thereof.

However, an analysis should never rely on the location of a resource. If an analysis needs access to further resources, it should use the Project class.

Linear Supertypes
AnyRef, Any
Known Subclasses
AnalysisAggregator, DefaultOneStepAnalysis, OneStepAnalysis, ReportableAnalysisAdapter
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Analysis
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def analyze(project: Project[Source], parameters: Seq[String] = List.empty, initProgressManagement: (Int) ⇒ ProgressManagement): AnalysisResult

    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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def copyright: String

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

  7. 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.
  8. 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.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. 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.

  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped