org.apache.hadoop.hbase
Enum KeepDeletedCells

java.lang.Object
  java.lang.Enum<KeepDeletedCells>
      org.apache.hadoop.hbase.KeepDeletedCells

All Implemented Interfaces:

Serializable, Comparable<KeepDeletedCells>

public enum KeepDeletedCells
extends Enum<KeepDeletedCells>

Ways to keep cells marked for delete around.

Enum Constant Summary

FALSE
Deleted Cells are not retained.

TRUE
Deleted Cells are retained until they are removed by other means such TTL or VERSIONS.

TTL
Deleted Cells are retained until the delete marker expires due to TTL.

Method Summary

static KeepDeletedCells	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeepDeletedCells[]	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

FALSE

public static final KeepDeletedCells FALSE

Deleted Cells are not retained.

TRUE

public static final KeepDeletedCells TRUE

Deleted Cells are retained until they are removed by other means such TTL or VERSIONS. If no TTL is specified or no new versions of delete cells are written, they are retained forever.

TTL

public static final KeepDeletedCells TTL

Deleted Cells are retained until the delete marker expires due to TTL. This is useful when TTL is combined with MIN_VERSIONS and one wants to keep a minimum number of versions around but at the same time remove deleted cells after the TTL.

Method Detail

values

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

Returns:

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

valueOf

public static KeepDeletedCells 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