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

final case class Relevance(value: Int) extends AnyVal with Product with Serializable

Describes the overall relevance of a finding.

When calculating the relevance of a finding you should take all properties of the associated issue into consideration:

  • kind of issue
  • category of issue
  • accuracy of the analysis
value

A value between 0 (undetermined), 1 (not relevant) and 100 (absolutely relevant).

Source
Relevance.scala
Linear Supertypes
Serializable, Product, Equals, AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Relevance
  2. Serializable
  3. Product
  4. Equals
  5. AnyVal
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Relevance(value: Int)

    value

    A value between 0 (undetermined), 1 (not relevant) and 100 (absolutely relevant).

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  6. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  7. def merge(other: Relevance): Relevance
  8. def name: String
  9. def productElementNames: Iterator[String]
    Definition Classes
    Product
  10. def toAnsiColoredString: String
  11. def toEclipseConsoleString: String
  12. def toHTMLColor: String

    The lower the value, the "whiter" the color.

    The lower the value, the "whiter" the color. If the value is 100 then the color will be black.

  13. def toIDL: JsValue
  14. val value: Int

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyVal

Inherited from Any

Ungrouped