org.sonar.api.batch.sensor.symbol

Interface NewSymbol

public interface NewSymbol

This builder is used to define symbol references on files.

Since:

5.6

Method Summary

Modifier and Type	Method and Description
NewSymbol	newReference(int startOffset, int endOffset) Register a new symbol reference.
NewSymbol	newReference(int startLine, int startLineOffset, int endLine, int endLineOffset) Shortcut to avoid calling InputFile.newRange(int, int, int, int)
NewSymbol	newReference(TextRange range) Register a new symbol.

Method Detail

newReference

NewSymbol newReference(int startOffset,
                       int endOffset)

Register a new symbol reference.

Parameters:

startOffset - Starting position in file for the declaration of this symbol. Beginning of a file starts with offset '0'.

endOffset - End position in file for this symbol declaration.

newReference

NewSymbol newReference(TextRange range)

Register a new symbol.

Parameters:

range - Range of text for the symbol declaration. See for example InputFile.newRange(int, int, int, int).

newReference

NewSymbol newReference(int startLine,
                       int startLineOffset,
                       int endLine,
                       int endLineOffset)

Shortcut to avoid calling InputFile.newRange(int, int, int, int)