org.subtlelib.poi.api.navigation

Interface RowNavigation<S,R>

Type Parameters:

S - sheet context type

R - row context type

All Superinterfaces:

RowCondition<R>

All Known Subinterfaces:

RowContext, SheetContext

All Known Implementing Classes:

AbstractDelegatingRowContext, RowContextImpl, RowContextNoImpl, SheetContextImpl, SheetContextNoImpl

public interface RowNavigation<S,R>
extends RowCondition<R>

Row navigation within the sheet routines.

Author:

i.voshkulat

Method Summary

Modifier and Type	Method and Description
R	currentRow() Retrieve current row, i.e.
R	nextRow() Create subsequent row and place current row pointer on it.
S	skipRow() Move current row pointer to the next position within the sheet.
S	skipRows(int offset) Move current row pointer by offset rows within the sheet.
S	stepOneRowBack()

Methods inherited from interface org.subtlelib.poi.api.condition.RowCondition

nextConditionalRow

Method Detail

nextRow

R nextRow()

Create subsequent row and place current row pointer on it.

Returns:

created row

currentRow

R currentRow()

Retrieve current row, i.e. last row created (see nextRow() and RowCondition.nextConditionalRow(boolean)) within current sheet. Is not affected by skipRow() or skipRows(int).

Returns:

current row RowContext

skipRow

S skipRow()

Move current row pointer to the next position within the sheet. Doesn't involve actual row creation but just the position in which the next row will be created with nextRow() or RowCondition.nextConditionalRow(boolean).

Returns:

current sheet SheetContext

skipRows

S skipRows(int offset)

Move current row pointer by offset rows within the sheet. Doesn't involve actual row creation but just the position in which the next row will be created with nextRow() or RowCondition.nextConditionalRow(boolean).

Parameters:

offset - number of rows to move pointer by

Returns:

current sheet SheetContext

stepOneRowBack

S stepOneRowBack()