Object

org.opalj.ai

MethodsThatAlwaysReturnAPassedParameter

Related Doc: package ai

Permalink

object MethodsThatAlwaysReturnAPassedParameter extends DefaultOneStepAnalysis

A very small analysis that identifies those methods that always return a value that was passed as a parameter to the method; the self reference this is also treated as a(n implicit) parameter.

Source
MethodsThatAlwaysReturnAPassedParameter.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MethodsThatAlwaysReturnAPassedParameter
  2. DefaultOneStepAnalysis
  3. OneStepAnalysis
  4. Analysis
  5. AnalysisExecutor
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final val analysis: DefaultOneStepAnalysis

    Permalink

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

    Permalink

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

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

    Permalink

    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
    OneStepAnalysisAnalysis
  7. final def asInstanceOf[T0]: T0

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

    Permalink

    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
  9. def clone(): AnyRef

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

    Permalink

    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
  11. def description: String

    Permalink

    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
    MethodsThatAlwaysReturnAPassedParameterAnalysis
  12. def doAnalyze(theProject: Project[URL], parameters: Seq[String], isInterrupted: () ⇒ Boolean): BasicReport

    Permalink
  13. def documentationUrl: Option[String]

    Permalink

    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
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnalysisExecutor
  19. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  21. def main(args: Array[String]): Unit

    Permalink
    Definition Classes
    AnalysisExecutor
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def printUsage(implicit logContext: LogContext): Unit

    Permalink

    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
  26. def setupProject(cpFiles: Iterable[File], libcpFiles: Iterable[File], completelyLoadLibraries: Boolean, analysisMode: AnalysisMode, fallbackConfiguration: Config)(implicit initialLogContext: LogContext): Project[URL]

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

    Permalink
    Definition Classes
    AnyRef
  28. def title: String

    Permalink

    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
    MethodsThatAlwaysReturnAPassedParameterAnalysis
  29. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from DefaultOneStepAnalysis

Inherited from OneStepAnalysis[URL, BasicReport]

Inherited from Analysis[URL, BasicReport]

Inherited from AnalysisExecutor

Inherited from AnyRef

Inherited from Any

Ungrouped