org.apache.hadoop.hbase.client

Interface ResultScanner

All Superinterfaces:

AutoCloseable, Closeable, Iterable<Result>

All Known Implementing Classes:

AbstractClientScanner, ClientScanner, ClientSideRegionScanner, ClientSmallReversedScanner, ClientSmallScanner, ReversedClientScanner, TableSnapshotScanner

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface ResultScanner
extends Closeable, Iterable<Result>

Interface for client-side scanning. Go to HTable to obtain instances.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the scanner and releases any resources it has allocated
Result	next() Grab the next row's worth of values.
Result[]	next(int nbRows)

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

next

Result next()
            throws IOException

Grab the next row's worth of values. The scanner will return a Result.

Returns:

Result object if there is another row, null if the scanner is exhausted.

Throws:

IOException - e

next

Result[] next(int nbRows)
              throws IOException

Parameters:

nbRows - number of rows to return

Returns:

Between zero and nbRows Results

Throws:

IOException - e

close

void close()

Closes the scanner and releases any resources it has allocated

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable