Package org.sonar.java.reporting

Class AnalyzerMessage

java.lang.Object

org.sonar.java.reporting.AnalyzerMessage

public class AnalyzerMessage
extends Object

Class used to represent analyzer issue messages

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AnalyzerMessage.TextSpan

Field Summary

Fields

Modifier and Type	Field	Description
final List<List<AnalyzerMessage>>	flows

Constructor Summary

Constructors

Constructor	Description
AnalyzerMessage(JavaCheck check, org.sonar.api.batch.fs.InputComponent inputComponent, int line, String message, int cost)
AnalyzerMessage(JavaCheck check, org.sonar.api.batch.fs.InputComponent inputComponent, AnalyzerMessage.TextSpan textSpan, String message, int cost)

Method Summary

Modifier and Type	Method	Description
JavaCheck	getCheck()
Double	getCost()
org.sonar.api.batch.fs.InputComponent	getInputComponent()
Integer	getLine()
String	getMessage()
AnalyzerMessage.TextSpan	primaryLocation()
static AnalyzerMessage.TextSpan	textSpanBetween(Tree startTree, boolean includeStart, Tree endTree, boolean includeEnd)
static AnalyzerMessage.TextSpan	textSpanBetween(Tree startTree, Tree endTree)
static AnalyzerMessage.TextSpan	textSpanFor(Tree syntaxNode)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

flows

public final List<List<AnalyzerMessage>> flows

Constructor Details

AnalyzerMessage

public AnalyzerMessage(JavaCheck check,
 org.sonar.api.batch.fs.InputComponent inputComponent,
 int line,
 String message,
 int cost)

AnalyzerMessage

public AnalyzerMessage(JavaCheck check,
 org.sonar.api.batch.fs.InputComponent inputComponent,
 @Nullable
 AnalyzerMessage.TextSpan textSpan,
 String message,
 int cost)

Method Details

getCheck

public JavaCheck getCheck()

getInputComponent

public org.sonar.api.batch.fs.InputComponent getInputComponent()

primaryLocation

@Nullable
public AnalyzerMessage.TextSpan primaryLocation()

Returns:

null, when target of a message - is a file

getLine

@Nullable
public Integer getLine()

Returns:

null, when target of a message - is a file

getMessage

public String getMessage()

getCost

@Nullable
public Double getCost()

textSpanFor

public static AnalyzerMessage.TextSpan textSpanFor(Tree syntaxNode)

textSpanBetween

public static AnalyzerMessage.TextSpan textSpanBetween(Tree startTree,
 Tree endTree)

textSpanBetween

public static AnalyzerMessage.TextSpan textSpanBetween(Tree startTree,
 boolean includeStart,
 Tree endTree,
 boolean includeEnd)

toString

public String toString()

Overrides:

toString in class Object