org.apache.hadoop.hbase.codec.prefixtree.scanner
Enum CellScannerPosition

java.lang.Object
  java.lang.Enum<CellScannerPosition>
      org.apache.hadoop.hbase.codec.prefixtree.scanner.CellScannerPosition

All Implemented Interfaces:

Serializable, Comparable<CellScannerPosition>

@InterfaceAudience.Private
public enum CellScannerPosition
extends Enum<CellScannerPosition>

An indicator of the state of the scanner after an operation such as nextCell() or positionAt(..). For example:

• In a DataBlockScanner, the AFTER_LAST position indicates to the parent StoreFileScanner that it should load the next block.
• In a StoreFileScanner, the AFTER_LAST position indicates that the file has been exhausted.
• In a RegionScanner, the AFTER_LAST position indicates that the scanner should move to the next region.

Enum Constant Summary

AFTER
getCurrentCell() will return a valid cell, but it is not the cell requested by positionAt(..), rather it is the nearest cell after the requested cell.

AFTER_LAST
getCurrentCell() will NOT return a valid cell.

AT
getCurrentCell() will return a valid cell, and it is exactly the cell that was requested by positionAt(..).

BEFORE
getCurrentCell() will return a valid cell, but it is not the cell requested by positionAt(..), rather it is the nearest cell before the requested cell.

BEFORE_FIRST
getCurrentCell() will NOT return a valid cell.

Method Summary

static CellScannerPosition	valueOf(String name) Returns the enum constant of this type with the specified name.
static CellScannerPosition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BEFORE_FIRST

public static final CellScannerPosition BEFORE_FIRST

getCurrentCell() will NOT return a valid cell. Calling nextCell() will advance to the first cell.

BEFORE

public static final CellScannerPosition BEFORE

getCurrentCell() will return a valid cell, but it is not the cell requested by positionAt(..), rather it is the nearest cell before the requested cell.

AT

public static final CellScannerPosition AT

getCurrentCell() will return a valid cell, and it is exactly the cell that was requested by positionAt(..).

AFTER

public static final CellScannerPosition AFTER

getCurrentCell() will return a valid cell, but it is not the cell requested by positionAt(..), rather it is the nearest cell after the requested cell.

AFTER_LAST

public static final CellScannerPosition AFTER_LAST

getCurrentCell() will NOT return a valid cell. Calling nextCell() will have no effect.

Method Detail

values

public static CellScannerPosition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CellScannerPosition c : CellScannerPosition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CellScannerPosition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null