ScanQueryMatcher.MatchCode (Apache HBase 2.2.3 API)

java.lang.Object
- java.lang.Enum<ScanQueryMatcher.MatchCode>
- - org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher.MatchCode

All Implemented Interfaces:

Serializable, Comparable<ScanQueryMatcher.MatchCode>

Enclosing class:

ScanQueryMatcher
```
public static enum ScanQueryMatcher.MatchCode
extends Enum<ScanQueryMatcher.MatchCode>
```
ScanQueryMatcher.match(org.apache.hadoop.hbase.Cell) return codes. These instruct the scanner moving through memstores and StoreFiles what to do with the current KeyValue.
Additionally, this contains "early-out" language to tell the scanner to move on to the next File (memstore or Storefile), or to return immediately.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DONE` Do not include, return current result
`DONE_SCAN` Done with scan, thanks to the row filter.
`INCLUDE` Include KeyValue in the returned result
`INCLUDE_AND_SEEK_NEXT_COL` Include KeyValue and done with column, seek to next.
`INCLUDE_AND_SEEK_NEXT_ROW` Include KeyValue and done with row, seek to next.
`NEXT` Do not include, jump to next StoreFile or memstore (in time order)
`SEEK_NEXT_COL` Done with column, seek to next.
`SEEK_NEXT_ROW` Done with the row, seek there.
`SEEK_NEXT_USING_HINT` Seek to next key which is given as hint.
`SKIP` Do not include KeyValue in the returned result

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ScanQueryMatcher.MatchCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ScanQueryMatcher.MatchCode[]`	`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 ScanQueryMatcher.MatchCode INCLUDE
```
    Include KeyValue in the returned result
  - SKIP
```
public static final ScanQueryMatcher.MatchCode SKIP
```
    Do not include KeyValue in the returned result
  - NEXT
```
public static final ScanQueryMatcher.MatchCode NEXT
```
    Do not include, jump to next StoreFile or memstore (in time order)
  - DONE
```
public static final ScanQueryMatcher.MatchCode DONE
```
    Do not include, return current result
  - SEEK_NEXT_ROW
```
public static final ScanQueryMatcher.MatchCode SEEK_NEXT_ROW
```
    Done with the row, seek there.
  - SEEK_NEXT_COL
```
public static final ScanQueryMatcher.MatchCode SEEK_NEXT_COL
```
    Done with column, seek to next.
  - DONE_SCAN
```
public static final ScanQueryMatcher.MatchCode DONE_SCAN
```
    Done with scan, thanks to the row filter.
  - SEEK_NEXT_USING_HINT
```
public static final ScanQueryMatcher.MatchCode SEEK_NEXT_USING_HINT
```
    Seek to next key which is given as hint.
  - INCLUDE_AND_SEEK_NEXT_COL
```
public static final ScanQueryMatcher.MatchCode INCLUDE_AND_SEEK_NEXT_COL
```
    Include KeyValue and done with column, seek to next.
  - INCLUDE_AND_SEEK_NEXT_ROW
```
public static final ScanQueryMatcher.MatchCode INCLUDE_AND_SEEK_NEXT_ROW
```
    Include KeyValue and done with row, seek to next.
- Method Detail
  - values
```
public static ScanQueryMatcher.MatchCode[] 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 (ScanQueryMatcher.MatchCode c : ScanQueryMatcher.MatchCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ScanQueryMatcher.MatchCode 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

Enum ScanQueryMatcher.MatchCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INCLUDE

SKIP

NEXT

DONE

SEEK_NEXT_ROW

SEEK_NEXT_COL

DONE_SCAN

SEEK_NEXT_USING_HINT

INCLUDE_AND_SEEK_NEXT_COL

INCLUDE_AND_SEEK_NEXT_ROW

Method Detail

values

valueOf