org.wickedsource.diffparser.unified

Class ResizingParseWindow

java.lang.Object

org.wickedsource.diffparser.unified.ResizingParseWindow

All Implemented Interfaces:

ParseWindow

public class ResizingParseWindow
extends Object
implements ParseWindow

A ResizingParseWindow slides through the lines of a input stream and offers methods to get the currently focused line as well as upcoming lines. It is backed by an automatically resizing LinkedList

Author:

Tom Hombergs

Constructor Summary

Constructors

Constructor and Description
ResizingParseWindow(InputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
void	addIgnorePattern(String ignorePattern)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResizingParseWindow

public ResizingParseWindow(InputStream in)

Method Detail

addIgnorePattern

public void addIgnorePattern(String ignorePattern)

getFutureLine

public String getFutureLine(int distance)

Description copied from interface: ParseWindow

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

Specified by:

getFutureLine in interface ParseWindow

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

public void addLine(int pos,
           String line)

Specified by:

addLine in interface ParseWindow

slideForward

public String slideForward()

Description copied from interface: ParseWindow

Slides the window forward one line.

Specified by:

slideForward in interface ParseWindow

Returns:

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

getFocusLine

public String getFocusLine()

Description copied from interface: ParseWindow

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

Specified by:

getFocusLine in interface ParseWindow

Returns:

the currently focused line.

getFocusLineNumber

public int getFocusLineNumber()

Description copied from interface: ParseWindow

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

Specified by:

getFocusLineNumber in interface ParseWindow

Returns:

the line number.