org.apache.hadoop.hbase.filter

Enum Filter.ReturnCode

java.lang.Object

java.lang.Enum<Filter.ReturnCode>

org.apache.hadoop.hbase.filter.Filter.ReturnCode

All Implemented Interfaces:

Serializable, Comparable<Filter.ReturnCode>

Enclosing class:

Filter

@InterfaceAudience.Public
public static enum Filter.ReturnCode
extends Enum<Filter.ReturnCode>

Return codes for filterValue().

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCLUDE Include the Cell
INCLUDE_AND_NEXT_COL Include the Cell and seek to the next column skipping older versions.
INCLUDE_AND_SEEK_NEXT_ROW Include KeyValue and done with row, seek to next.
NEXT_COL Skip this column.
NEXT_ROW Seek to next row in current family.
SEEK_NEXT_USING_HINT Seek to next key which is given as hint by the filter.
SKIP Skip this Cell

Method Summary

Modifier and Type	Method and Description
static Filter.ReturnCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Filter.ReturnCode[]	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

INCLUDE

public static final Filter.ReturnCode INCLUDE

Include the Cell

INCLUDE_AND_NEXT_COL

public static final Filter.ReturnCode INCLUDE_AND_NEXT_COL

Include the Cell and seek to the next column skipping older versions.

SKIP

public static final Filter.ReturnCode SKIP

Skip this Cell

NEXT_COL

public static final Filter.ReturnCode NEXT_COL

Skip this column. Go to the next column in this row.

NEXT_ROW

public static final Filter.ReturnCode NEXT_ROW

Seek to next row in current family. It may still pass a cell whose family is different but row is the same as previous cell to Filter.filterCell(Cell) , even if we get a NEXT_ROW returned for previous cell. For more details see HBASE-18368.
Once reset() method was invoked, then we switch to the next row for all family, and you can catch the event by invoking CellUtils.matchingRows(previousCell, currentCell).
Note that filterRow() will still be called.

SEEK_NEXT_USING_HINT

public static final Filter.ReturnCode SEEK_NEXT_USING_HINT

Seek to next key which is given as hint by the filter.

INCLUDE_AND_SEEK_NEXT_ROW

public static final Filter.ReturnCode INCLUDE_AND_SEEK_NEXT_ROW

Include KeyValue and done with row, seek to next. See NEXT_ROW.

Method Detail

values

public static Filter.ReturnCode[] 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 (Filter.ReturnCode c : Filter.ReturnCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Filter.ReturnCode 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