ReportableAnalysisAdapter

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. val analysis: Analysis[Source, AnalysisResult]

   

5. def analyze(project: Project[Source], parameters: Seq[String], initProgressManagement: (Int) ⇒ ProgressManagement): ReportableAnalysisResult

   

   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

   ReportableAnalysisAdapter → Analysis

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. val converter: (AnalysisResult) ⇒ String

   

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

   ReportableAnalysisAdapter → Analysis

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

    ReportableAnalysisAdapter → Analysis

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

12. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

13. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

14. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

15. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

16. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

17. final def notify(): Unit

    

    Definition Classes

    AnyRef

18. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnyRef

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

    ReportableAnalysisAdapter → Analysis

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

    @throws( ... )