org.sonar.api.batch.sensor.highlighting.internal

Class DefaultHighlighting

java.lang.Object

org.sonar.api.batch.sensor.internal.DefaultStorable

org.sonar.api.batch.sensor.highlighting.internal.DefaultHighlighting

All Implemented Interfaces:

NewHighlighting

public class DefaultHighlighting
extends DefaultStorable
implements NewHighlighting

Field Summary

Fields inherited from class org.sonar.api.batch.sensor.internal.DefaultStorable

storage

Constructor Summary

Constructors

Constructor and Description
DefaultHighlighting(SensorStorage storage)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doSave()
List<SyntaxHighlightingRule>	getSyntaxHighlightingRuleSet()
DefaultHighlighting	highlight(int startOffset, int endOffset, TypeOfText typeOfText) Call this method to indicate the type of text in a range.
InputFile	inputFile()
DefaultHighlighting	onFile(InputFile inputFile) The file the highlighting belongs to.

Methods inherited from class org.sonar.api.batch.sensor.internal.DefaultStorable

save, toString, validateLineArgument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.api.batch.sensor.highlighting.NewHighlighting

save

Constructor Detail

DefaultHighlighting

public DefaultHighlighting(SensorStorage storage)

Method Detail

getSyntaxHighlightingRuleSet

public List<SyntaxHighlightingRule> getSyntaxHighlightingRuleSet()

onFile

public DefaultHighlighting onFile(InputFile inputFile)

Description copied from interface: NewHighlighting

The file the highlighting belongs to.

Specified by:

onFile in interface NewHighlighting

inputFile

public InputFile inputFile()

highlight

public DefaultHighlighting highlight(int startOffset,
                            int endOffset,
                            TypeOfText typeOfText)

Description copied from interface: NewHighlighting

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

Specified by:

highlight in interface NewHighlighting

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.

doSave

protected void doSave()

Specified by:

doSave in class DefaultStorable