Package com.apple.foundationdb.record
Class IndexScanType
- java.lang.Object
-
- com.apple.foundationdb.record.IndexScanType
-
- All Implemented Interfaces:
PlanHashable
@API(MAINTAINED) public class IndexScanType extends Object implements PlanHashable
The way in which an index should be scanned. The set of allowed scan types varies by the type of the index. This isn't an enum so clients can define more of them for their own index maintainers.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.apple.foundationdb.record.PlanHashable
PlanHashable.PlanHashKind
-
-
Field Summary
Fields Modifier and Type Field Description static IndexScanType
BY_GROUP
static IndexScanType
BY_RANK
static IndexScanType
BY_TEXT_TOKEN
static IndexScanType
BY_TIME_WINDOW
static IndexScanType
BY_VALUE
-
Constructor Summary
Constructors Constructor Description IndexScanType(String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
int
hashCode()
int
planHash(PlanHashable.PlanHashKind hashKind)
Return a hash similar tohashCode
, but with the additional guarantee that is is stable across JVMs.String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.apple.foundationdb.record.PlanHashable
planHash
-
-
-
-
Field Detail
-
BY_VALUE
@Nonnull public static final IndexScanType BY_VALUE
-
BY_RANK
@Nonnull public static final IndexScanType BY_RANK
-
BY_GROUP
@Nonnull public static final IndexScanType BY_GROUP
-
BY_TIME_WINDOW
@Nonnull public static final IndexScanType BY_TIME_WINDOW
-
BY_TEXT_TOKEN
@Nonnull public static final IndexScanType BY_TEXT_TOKEN
-
-
Constructor Detail
-
IndexScanType
public IndexScanType(String name)
-
-
Method Detail
-
planHash
public int planHash(@Nonnull PlanHashable.PlanHashKind hashKind)
Description copied from interface:PlanHashable
Return a hash similar tohashCode
, but with the additional guarantee that is is stable across JVMs.- Specified by:
planHash
in interfacePlanHashable
- Parameters:
hashKind
- the "kind" of hash to calculate. Each kind of hash has a particular logic with regards to included and excluded items.- Returns:
- a stable hash code
-
-