org.sonar.java

Class AnalyzerMessage

java.lang.Object

org.sonar.java.AnalyzerMessage

public class AnalyzerMessage
extends Object

Replacement for CheckMessage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyzerMessage.TextSpan

Field Summary

Fields

Modifier and Type	Field and Description
List<AnalyzerMessage>	secondaryLocations

Constructor Summary

Constructors

Constructor and Description
AnalyzerMessage(JavaCheck check, File file, AnalyzerMessage.TextSpan textSpan, String message, int cost)
AnalyzerMessage(JavaCheck check, File file, int line, String message, int cost)

Method Summary

Modifier and Type	Method and Description
JavaCheck	getCheck()
Double	getCost()
File	getFile()
Integer	getLine()
String	getMessage()
AnalyzerMessage.TextSpan	primaryLocation()
static AnalyzerMessage.TextSpan	textSpanBetween(Tree startTree, Tree endTree)
static AnalyzerMessage.TextSpan	textSpanFor(Tree syntaxNode)

Methods inherited from class java.lang.Object

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

Field Detail

secondaryLocations

public final List<AnalyzerMessage> secondaryLocations

Constructor Detail

AnalyzerMessage

public AnalyzerMessage(JavaCheck check,
                       File file,
                       int line,
                       String message,
                       int cost)

AnalyzerMessage

public AnalyzerMessage(JavaCheck check,
                       File file,
                       @Nullable
                       AnalyzerMessage.TextSpan textSpan,
                       String message,
                       int cost)

Method Detail

getCheck

public JavaCheck getCheck()

getFile

public File getFile()

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)