hbase-client/src/main/java/org/apache/hadoop/hbase/KeepDeletedCells.java

   1 /**
   2  *
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19 package org.apache.hadoop.hbase;
  20
  21 import org.apache.yetus.audience.InterfaceAudience;
  22
  23 /**
  24  * Ways to keep cells marked for delete around.
  25  */
  26 /*
  27  * Don't change the TRUE/FALSE labels below, these have to be called
  28  * this way for backwards compatibility.
  29  */
  30 @InterfaceAudience.Public
  31 public enum KeepDeletedCells {
  32   /** Deleted Cells are not retained. */
  33   FALSE,
  34   /**
  35    * Deleted Cells are retained until they are removed by other means
  36    * such TTL or VERSIONS.
  37    * If no TTL is specified or no new versions of delete cells are
  38    * written, they are retained forever.
  39    */
  40   TRUE,
  41   /**
  42    * Deleted Cells are retained until the delete marker expires due to TTL.
  43    * This is useful when TTL is combined with MIN_VERSIONS and one
  44    * wants to keep a minimum number of versions around but at the same
  45    * time remove deleted cells after the TTL.
  46    */
  47   TTL;
  48   public static KeepDeletedCells getValue(String val) {
  49     return valueOf(val.toUpperCase());
  50   }
  51 }