Issue

Instance Constructors

new Issue(analysis: String, relevance: Relevance, summary: String, categories: Set[String], kinds: Set[String], locations: Seq[IssueLocation], details: Traversable[IssueDetails] = Nil)

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!

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Issue to any2stringadd[Issue] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Issue, B)

Implicit information
This member is added by an implicit conversion from Issue to ArrowAssoc[Issue] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val analysis: String

The unique id of the analysis.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val categories: Set[String]

A string that uses small letters and which describes the category of the issue.
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).
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val details: Traversable[IssueDetails]
def ensuring(cond: (Issue) ⇒ Boolean, msg: ⇒ Any): Issue

Implicit information
This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Issue) ⇒ Boolean): Issue

Implicit information
This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Issue

Implicit information
This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Issue

Implicit information
This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Issue to StringFormat[Issue] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

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

Definition Classes
Any
val kinds: Set[String]

A string that uses small letters and which describes the kind of the issue.
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).
val locations: Seq[IssueLocation]

The source code locations related to this issue.
The source code locations related to this issue. This seq must not be empty!
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val relevance: Relevance

The relevance of the issue.
val summary: String

The issue in one short sentence (no line breaks)!
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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
Issue → IssueRepresentations
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
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
Issue → IssueRepresentations
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
Issue → IssueRepresentations
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
Issue → IssueRepresentations
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Issue, B)

Implicit information
This member is added by an implicit conversion from Issue to ArrowAssoc[Issue] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from IssueRepresentations

Inherited from ReportableAnalysisResult

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Issue to any2stringadd[Issue]

Inherited by implicit conversion StringFormat from Issue to StringFormat[Issue]

Inherited by implicit conversion Ensuring from Issue to Ensuring[Issue]

Inherited by implicit conversion ArrowAssoc from Issue to ArrowAssoc[Issue]

Ungrouped

Related Doc: package issues

case class Issue(analysis: String, relevance: Relevance, summary: String, categories: Set[String], kinds: Set[String], locations: Seq[IssueLocation], details: Traversable[IssueDetails] = Nil) extends IssueRepresentations with Product with Serializable

Instance Constructors

new Issue(analysis: String, relevance: Relevance, summary: String, categories: Set[String], kinds: Set[String], locations: Seq[IssueLocation], details: Traversable[IssueDetails] = Nil)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Issue, B)

final def ==(arg0: Any): Boolean

val analysis: String

final def asInstanceOf[T0]: T0

val categories: Set[String]

def clone(): AnyRef

val details: Traversable[IssueDetails]

def ensuring(cond: (Issue) ⇒ Boolean, msg: ⇒ Any): Issue

def ensuring(cond: (Issue) ⇒ Boolean): Issue

def ensuring(cond: Boolean, msg: ⇒ Any): Issue

def ensuring(cond: Boolean): Issue

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val kinds: Set[String]

val locations: Seq[IssueLocation]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val relevance: Relevance

val summary: String

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

def toAnsiColoredString: String

Example

def toConsoleString: String

def toEclipseConsoleString: String

def toIDL: JsValue

def toXHTML(basicInfoOnly: Boolean): Node

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (Issue, B)

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from IssueRepresentations

Inherited from ReportableAnalysisResult

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Issue to any2stringadd[Issue]

Inherited by implicit conversion StringFormat from Issue to StringFormat[Issue]

Inherited by implicit conversion Ensuring from Issue to Ensuring[Issue]

Inherited by implicit conversion ArrowAssoc from Issue to ArrowAssoc[Issue]

Ungrouped