Enum IndexOrphanBehavior
- java.lang.Object
-
- java.lang.Enum<IndexOrphanBehavior>
-
- com.apple.foundationdb.record.provider.foundationdb.IndexOrphanBehavior
-
- All Implemented Interfaces:
Serializable
,Comparable<IndexOrphanBehavior>
@API(STABLE) public enum IndexOrphanBehavior extends Enum<IndexOrphanBehavior>
Provided during index scan operations in which associated records are being retrieved, to indicate what should happen in response to an index entry which has no associated record. This situation should only arrive in indexes in which the maintenance of a delete is too expensive and must be deferred to some kind of external support job.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static IndexOrphanBehavior
valueOf(String name)
Returns the enum constant of this type with the specified name.static IndexOrphanBehavior[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ERROR
public static final IndexOrphanBehavior ERROR
Throw an exception when an orphaned entry is hit. This is the default behavior for most indexes in which we never expect orphaned entries.
-
SKIP
public static final IndexOrphanBehavior SKIP
Silently ignore the index entry. This would be used when scanning an index that is known to contain (or likely contain) orphaned entries.
-
RETURN
public static final IndexOrphanBehavior RETURN
Return the index entry but with no record associated with it. This would most likely be used when implementing the deferred maintenance of the index to recognize when there are orphaned entries and to then take care of cleaning them up.
-
-
Method Detail
-
values
public static IndexOrphanBehavior[] 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 (IndexOrphanBehavior c : IndexOrphanBehavior.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static IndexOrphanBehavior 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 nameNullPointerException
- if the argument is null
-
-