com.healthmarketscience.jackcess
Class UsageMap.PageCursor

java.lang.Object
  com.healthmarketscience.jackcess.UsageMap.PageCursor

Enclosing class:

UsageMap

public final class UsageMap.PageCursor
extends java.lang.Object

Utility class to traverse over the pages in the UsageMap. Remains valid in the face of usage map modifications.

Method Summary

void	afterLast() After calling this method, getPreviousPage() will return the last page in the map
void	beforeFirst() After calling this method, getNextPage() will return the first page in the map
int	getNextPage()
int	getPreviousPage()
UsageMap	getUsageMap()
boolean	isUpToDate() Returns true if this cursor is up-to-date with respect to its usage map.
void	reset() After calling this method, getNextPage will return the first page in the map
protected void	reset(boolean moveForward) Resets this page cursor for traversing the given direction.
protected void	restorePosition(int curPageNumber, int prevPageNumber) Restores a current and previous position for the cursor.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getUsageMap

public UsageMap getUsageMap()

isUpToDate

public boolean isUpToDate()

Returns true if this cursor is up-to-date with respect to its usage map.

getNextPage

public int getNextPage()

Returns:

valid page number if there was another page to read, RowId.LAST_PAGE_NUMBER otherwise

getPreviousPage

public int getPreviousPage()

Returns:

valid page number if there was another page to read, RowId.FIRST_PAGE_NUMBER otherwise

reset

public void reset()

After calling this method, getNextPage will return the first page in the map

beforeFirst

public void beforeFirst()

After calling this method, getNextPage() will return the first page in the map

afterLast

public void afterLast()

After calling this method, getPreviousPage() will return the last page in the map

reset

protected void reset(boolean moveForward)

Resets this page cursor for traversing the given direction.

restorePosition

protected void restorePosition(int curPageNumber,
                               int prevPageNumber)

Restores a current and previous position for the cursor.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object