package issues
Defines implicit conversions to wrap some types of analyses such that they generate results of type org.opalj.br.analyses.ReportableAnalysisResult.
- Source
- package.scala
- Alphabetic
- By Inheritance
- issues
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait ClassComprehension extends AnyRef
- class ClassLocation extends PackageLocation with ClassComprehension
- trait CodeComprehension extends AnyRef
- class FieldLocation extends ClassLocation
- class FieldValues extends IssueDetails with MethodComprehension
Describes an issue related to the value of a field.
- class InstructionLocation extends MethodLocation with PCLineComprehension
- case class Issue(analysis: String, relevance: Relevance, summary: String, categories: Set[String], kinds: Set[String], locations: Seq[IssueLocation], details: Iterable[IssueDetails] = Nil) extends IssueRepresentations with Product with Serializable
Describes some issue found in source code.
Describes some issue found in source code.
- analysis
The unique id of the analysis.
- relevance
The relevance of the issue.
- summary
The issue in one short sentence (no line breaks)!
- categories
A string that uses small letters and which describes the category of the issue. The category basically describes the property of the software that is affected by this issue (see IssueCategory for further details).
- kinds
A string that uses small letters and which describes the kind of the issue. The kind describes how this issue manifests itself in the source code (see IssueKind for further details).
- locations
The source code locations related to this issue. This seq must not be empty!
- trait IssueDetails extends IssueRepresentations
Information that facilitates the comprehension of a reported issue.
- sealed abstract class IssueLocation extends IssueRepresentations with Comparable[IssueLocation]
The location of an issue.
- trait IssueRepresentations extends ReportableAnalysisResult
Definition of the representations that can be generated from a given issue (or parts thereof).
- class LocalVariables extends IssueDetails
- trait MethodComprehension extends ClassComprehension
- class MethodLocation extends ClassLocation with MethodComprehension
- class MethodReturnValues extends IssueDetails with MethodComprehension
- class Operands extends IssueDetails with CodeComprehension
- trait PCLineComprehension extends MethodComprehension with CodeComprehension
- class PackageLocation extends ProjectLocation
- abstract class ProjectLocation extends IssueLocation
- final case class Relevance(value: Int) extends AnyVal with Product with Serializable
Describes the overall relevance of a finding.
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).
Value Members
- def absoluteToRelative(path: String): String
Shortens an absolute path to one relative to the current working directory.
- def fileToLocationIdentifier(file: File): String
- def localVariableToString(localVariable: LocalVariable, value: AnyRef): String
Given a
LocalVariableobject and its current value a human readableStringis created. - def methodToIDL(accessFlags: Int, name: String, descriptor: MethodDescriptor): JsObject
- def prettifyJarUrl(jarurl: String): String
Turns the jar URL format into a string better suited for the console reports.
- def typeToIDL(t: Type): JsValue
- def urlToLocationIdentifier(url: URL): String
Converts a URL into a string, intended to be displayed as part of console reports.
Converts a URL into a string, intended to be displayed as part of console reports.
Absolute file names are shortened to be relative to the current directory, to avoid using up too much screen space in the console.
- object IssueCategory
Collection of predefined issue categories where each category describes the quality property of the software that is affected by the issue.
- implicit object IssueDetailsWrites extends Writes[IssueDetails]
- object IssueKind
An issue kind describes how an issue manifests itself in the source code.
- implicit object IssueLocationWrites extends Writes[IssueLocation]
- object IssueOrdering extends Ordering[Issue]
Defines a partial order for issues.
Defines a partial order for issues. The issues are sorted first by the relevance, then by their locations, then by the categories, then by the kinds, then by the analyses' ids and at last by the summary.
- object PCLineComprehension
- object Relevance extends Serializable
Collection of pre-configured relevance levels.
- implicit object RelevanceWrites extends Writes[Relevance]