Package org.apache.hadoop.hbase.filter
Enum Class Filter.ReturnCode
- All Implemented Interfaces:
Serializable
,Comparable<Filter.ReturnCode>
,Constable
- Enclosing class:
- Filter
Return codes for filterValue().
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionInclude the CellInclude the Cell and seek to the next column skipping older versions.Include KeyValue and done with row, seek to next.Skip this column.Seek to next row in current family.Seek to next key which is given as hint by the filter.Skip this Cell -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Filter.ReturnCode
Returns the enum constant of this class with the specified name.static Filter.ReturnCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INCLUDE
Include the Cell -
INCLUDE_AND_NEXT_COL
Include the Cell and seek to the next column skipping older versions. -
SKIP
Skip this Cell -
NEXT_COL
Skip this column. Go to the next column in this row. -
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 toFilter.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
Seek to next key which is given as hint by the filter. -
INCLUDE_AND_SEEK_NEXT_ROW
Include KeyValue and done with row, seek to next. See NEXT_ROW.
-
-
Constructor Details
-
ReturnCode
private ReturnCode()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-