Package org.sonar.plugins.python.api

Class IssueLocation

java.lang.Object

org.sonar.plugins.python.api.IssueLocation

public abstract class IssueLocation
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	UNDEFINED_LINE
static final int	UNDEFINED_OFFSET

Method Summary

Modifier and Type	Method	Description
static IssueLocation	atFileLevel(String message)
static IssueLocation	atLineLevel(String message, int lineNumber, PythonFile pythonInputFile)
abstract int	endLine()
abstract int	endLineOffset()
abstract String	fileId()
String	message()
static IssueLocation	preciseLocation(LocationInFile locationInFile, String message)
static IssueLocation	preciseLocation(Token token, String message)
static IssueLocation	preciseLocation(Token from, Token to, String message)
static IssueLocation	preciseLocation(Tree tree, String message)
abstract int	startLine()
abstract int	startLineOffset()

Methods inherited from class java.lang.Object

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

Field Details

UNDEFINED_OFFSET

public static final int UNDEFINED_OFFSET

See Also:

• Constant Field Values

UNDEFINED_LINE

public static final int UNDEFINED_LINE

See Also:

• Constant Field Values

Method Details

atFileLevel

public static IssueLocation atFileLevel(String message)

atLineLevel

public static IssueLocation atLineLevel(String message,
 int lineNumber,
 PythonFile pythonInputFile)

preciseLocation

public static IssueLocation preciseLocation(Tree tree,
 @Nullable
 String message)

preciseLocation

public static IssueLocation preciseLocation(Token token,
 @Nullable
 String message)

preciseLocation

public static IssueLocation preciseLocation(Token from,
 Token to,
 @Nullable
 String message)

preciseLocation

public static IssueLocation preciseLocation(LocationInFile locationInFile,
 @Nullable
 String message)

message

@CheckForNull
public String message()

startLine

public abstract int startLine()

startLineOffset

public abstract int startLineOffset()

endLine

public abstract int endLine()

endLineOffset

public abstract int endLineOffset()

fileId

@CheckForNull
public abstract String fileId()