org.conqat.engine.commons.findings.location

Interface ILineAdjuster

All Known Implementing Classes:

LocationAdjuster, SimpleValidLinesFilter

public interface ILineAdjuster

Adjustes the location of a single line.

Method Summary

Modifier and Type	Method and Description
LineBasedRegion	adjustLine(int line, java.util.Set<java.lang.Integer> invalidLines) Adjusts the location of a single line.
int	getOriginalLineCount() Returns the line count of the original text

Method Detail

adjustLine

LineBasedRegion adjustLine(int line,
                           java.util.Set<java.lang.Integer> invalidLines)

Adjusts the location of a single line. This only respects the token part of a line, i.e. leading and trailing whitespace of a line will be ignored. This method is robust w.r.t lines numbers that are out of the range of the original text. In case of such an invalid line, the line is logged as error to the given logger and null is returned.

Parameters:

line - the one-based line number of be adjusted.

invalidLines - used for collecting invalid lines.

Returns:

the one-based lines encoded as a region, as a line may map to multiple lines after changing. This may also return null, if no non-empty lines could be found that correspond to the input line after adjustment.

getOriginalLineCount

int getOriginalLineCount()

Returns the line count of the original text