Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package opalj

    OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode.

    OPAL is a Scala-based framework for the static analysis, manipulation and creation of Java bytecode. OPAL is designed with performance, scalability and adaptability in mind.

    Its main components are:

    • a library (Common) which provides generally useful data-structures and algorithms for static analyses.
    • a framework for implementing lattice based static analyses (Static Analysis Infrastructure)
    • a framework for parsing Java bytecode (Bytecode Infrastructure) that can be used to create arbitrary representations.
    • a library to create a one-to-one in-memory representation of Java bytecode (Bytecode Disassembler).
    • a library to create a representation of Java bytecode that facilitates writing simple static analyses (Bytecode Representation - org.opalj.br).
    • a scalable, easily customizable framework for the abstract interpretation of Java bytecode (Abstract Interpretation Framework - org.opalj.ai).
    • a library to extract dependencies between code elements and to facilitate checking architecture definitions.
    • a library for the lightweight manipulation and creation of Java bytecode (Bytecode Assembler).

    General Design Decisions

    Thread Safety

    Unless explicitly noted, OPAL is thread safe. I.e., the classes defined by OPAL can be considered to be thread safe unless otherwise stated. (For example, it is possible to read and process class files concurrently without explicit synchronization on the client side.)

    No null Values

    Unless explicitly noted, OPAL does not null values I.e., fields that are accessible will never contain null values and methods will never return null. If a method accepts null as a value for a parameter or returns a null value it is always explicitly documented. In general, the behavior of methods that are passed null values is undefined unless explicitly documented.

    No Typecasts for Collections

    For efficiency reasons, OPAL sometimes uses mutable data-structures internally. After construction time, these data-structures are generally represented using their generic interfaces (e.g., scala.collection.{Set,Map}). However, a downcast (e.g., to add/remove elements) is always forbidden as it would effectively prevent thread-safety.

    Assertions

    OPAL makes heavy use of Scala's Assertion Facility to facilitate writing correct code. Hence, for production builds (after thorough testing(!)) it is highly recommend to build OPAL again using -Xdisable-assertions.

    Definition Classes
    org
  • package issues

    Defines implicit conversions to wrap some types of analyses such that they generate results of type org.opalj.br.analyses.ReportableAnalysisResult.

    Defines implicit conversions to wrap some types of analyses such that they generate results of type org.opalj.br.analyses.ReportableAnalysisResult.

    Definition Classes
    opalj
  • ClassComprehension
  • ClassLocation
  • CodeComprehension
  • FieldLocation
  • FieldValues
  • InstructionLocation
  • Issue
  • IssueCategory
  • IssueDetails
  • IssueDetailsWrites
  • IssueKind
  • IssueLocation
  • IssueLocationWrites
  • IssueOrdering
  • IssueRepresentations
  • LocalVariables
  • MethodComprehension
  • MethodLocation
  • MethodReturnValues
  • Operands
  • PCLineComprehension
  • PackageLocation
  • ProjectLocation
  • Relevance
  • RelevanceWrites
c

org.opalj.issues

MethodReturnValues

class MethodReturnValues extends IssueDetails with MethodComprehension

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MethodReturnValues
  2. MethodComprehension
  3. ClassComprehension
  4. IssueDetails
  5. IssueRepresentations
  6. ReportableAnalysisResult
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MethodReturnValues(method: Method, result: AIResult)

Value Members

  1. final def classFile: ClassFile
    Definition Classes
    MethodReturnValues → ClassComprehension
  2. def classFileFQN: String
    Definition Classes
    ClassComprehension
  3. def collectMethodReturnValues: List[PCAndAnyRef[String]]
  4. val method: Method
    Definition Classes
    MethodReturnValues → MethodComprehension
  5. def methodJVMSignature: String
    Definition Classes
    MethodComprehension
  6. val result: AIResult
  7. def toAnsiColoredString: String

    Representation of this issue well suited for console output if the console supports ANSI color escapes.

    Representation of this issue well suited for console output if the console supports ANSI color escapes.

    If you are generating output related to (a line in) a class file, use a format as used by other compilers, e.g., CLANG and GCC: 

    FILENAME:[LINE:[COLUMN:]] TYPE: MESSAGE
    where FILENAME denotes the name of the file, LINE is the line number if available, COLUMN is the column – which is usually not available when you analyze class files and TYPE identifies the type of the message (e.g., "note", "warning", "error", "fatal error").

    Line and column information is optional.

    If the real filename is not available use the fully qualified name of the class in binary notation (i.e., using "/" to separate the package qualifiers) with the suffice ".class" appended.

    Note that the space after the location information is required.

    Example

    demo/Buggy.class:100: warning: protected field in final class

    Definition Classes
    MethodReturnValues → IssueRepresentations
  8. def toConsoleString: String

    A basic representation of this issue well suited for console output.

    A basic representation of this issue well suited for console output.

    Definition Classes
    IssueRepresentations → ReportableAnalysisResult
  9. def toEclipseConsoleString: String

    A representation of this issue well suited for output to the Eclipse IDE console.

    A representation of this issue well suited for output to the Eclipse IDE console.

    Definition Classes
    MethodReturnValues → IssueRepresentations
  10. def toIDL: JsValue

    A representation of this issue using the Issues Description Language (which is a JSON dialect.)

    A representation of this issue using the Issues Description Language (which is a JSON dialect.)

    Definition Classes
    MethodReturnValues → IssueRepresentations
  11. def toXHTML(basicInfoOnly: Boolean): Node

    An (x)HTML5 representation of the issue, well suited for browser output.

    An (x)HTML5 representation of the issue, well suited for browser output.

    Definition Classes
    MethodReturnValues → IssueRepresentations