org.sonar.api.batch.sensor.highlighting

Interface NewHighlighting

All Known Implementing Classes:

DefaultHighlighting

@Beta
public interface NewHighlighting

This builder is used to define syntax highlighting (aka code coloration) on files.

Since:

5.1

Method Summary

Methods

Modifier and Type	Method and Description
NewHighlighting	highlight(int startOffset, int endOffset, TypeOfText typeOfText) Call this method to indicate the type of text in a range.
NewHighlighting	onFile(InputFile inputFile) The file the highlighting belongs to.
void	save() Call this method only once when your are done with defining highlighting of the file.

Method Detail

onFile

NewHighlighting onFile(InputFile inputFile)

The file the highlighting belongs to.

highlight

NewHighlighting highlight(int startOffset,
                        int endOffset,
                        TypeOfText typeOfText)

Call this method to indicate the type of text in a range.

Parameters:

startOffset - Starting position in file for this type of text. Beginning of a file starts with offset '0'.

endOffset - End position in file for this type of text.

typeOfText - see TypeOfText values.

save

void save()

Call this method only once when your are done with defining highlighting of the file.

Throws:

IllegalStateException - if you have defined overlapping highlighting