org.wickedsource.diffparser.unified

Interface ParseWindow

All Known Implementing Classes:

ResizingParseWindow

public interface ParseWindow

Method Summary

Methods

Modifier and Type	Method and Description
void	addLine(int pos, String line)
String	getFocusLine() Returns the line currently focused by this window.
int	getFocusLineNumber() Returns the number of the current line within the whole document.
String	getFutureLine(int distance) Looks ahead from the current line and retrieves a line that will be the focus line after the window has slided forward.
String	slideForward() Slides the window forward one line.

Method Detail

getFocusLine

String getFocusLine()

Returns the line currently focused by this window. This is actually the same line as returned by slideForward() but calling this method does not slide the window forward a step.

Returns:

the currently focused line.

getFocusLineNumber

int getFocusLineNumber()

Returns the number of the current line within the whole document.

Returns:

the line number.

slideForward

String slideForward()

Slides the window forward one line.

Returns:

the next line that is in the focus of this window or null if the end of the stream has been reached.

getFutureLine

String getFutureLine(int distance)

Looks ahead from the current line and retrieves a line that will be the focus line after the window has slided forward.

Parameters:

distance - the number of lines to look ahead. Must be greater or equal 0. 0 returns the focus line. 1 returns the first line after the current focus line and so on. Note that all lines up to the returned line will be held in memory until the window has slided past them, so be careful not to look ahead too far!

Returns:

the line identified by the distance parameter that lies ahead of the focus line. Returns null if the line cannot be read because it lies behind the end of the stream.

addLine

void addLine(int pos,
           String line)