Package com.sonarsource.cobol.api.issue

Interface LocationBuilder<T>

public interface LocationBuilder<T>

Method Summary

Modifier and Type	Method	Description
T	atLine(int line)	location is related to a specific line number of the the current source code file
T	atLine(File sourceCodeFile, int line)	location is related to a specific line number of the given source code file
T	on(AstNode node)
T	on(Token token)
T	onFile()	location is global to the current source code file (not at a specific line number)
T	onFile(File sourceCodeFile)	location is global to a specific source code file (not at a specific line number)
T	onRange(AstNode firstNode, AstNode lastNode)	precise issue location, see onRange(Token, Token)
T	onRange(Token firstToken, Token lastToken)	precise issue location
T	onRange(List<AstNode> nodeList)	precise issue location, see onRange(Token, Token)

Method Detail

onFile

T onFile()

location is global to the current source code file (not at a specific line number)

onFile

T onFile(@Nullable
         File sourceCodeFile)

location is global to a specific source code file (not at a specific line number)

atLine

T atLine(int line)

location is related to a specific line number of the the current source code file

Parameters:

line - , start at 1

atLine

T atLine(@Nullable
         File sourceCodeFile,
         int line)

location is related to a specific line number of the given source code file

Parameters:

sourceCodeFile - if null, the main source code file will be used

line - , start at 1

on

T on(Token token)

Parameters:

token - , precise issue location

on

T on(AstNode node)

Parameters:

node - , precise issue location

onRange

T onRange(Token firstToken,
          Token lastToken)

precise issue location

Parameters:

firstToken - , issue start at the beginning of firstToken

lastToken - , issue end at the end of lastToken. Note: lastToken should be after firstToken and in the same file, otherwise the range will just be firstToken)

onRange

T onRange(AstNode firstNode,
          AstNode lastNode)

precise issue location, see onRange(Token, Token)

onRange

T onRange(List<AstNode> nodeList)

precise issue location, see onRange(Token, Token)