hadoop-hdfs-project/hadoop-hdfs-client/src/main/java/org/apache/hadoop/hdfs/client/CreateEncryptionZoneFlag.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hdfs.client;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;

/**
 * CreateEncryptionZoneFlag is used in
 * {@link HdfsAdmin#createEncryptionZone(Path, String, EnumSet)} to indicate
 * what should be done when creating an encryption zone.
 *
 * Use CreateEncryptionZoneFlag as follows:
 * <ol>
 *   <li>PROVISION_TRASH - provision a trash directory for the encryption zone
 *   to support soft delete.</li>
 * </ol>
 */
@InterfaceAudience.Public
@InterfaceStability.Evolving
public enum CreateEncryptionZoneFlag {

  /**
   * Do not provision a trash directory in the encryption zone.
   *
   * @see CreateEncryptionZoneFlag#NO_TRASH
   */
  NO_TRASH((short) 0x00),
  /**
   * Provision a trash directory .Trash/ in the
   * encryption zone.
   *
   * @see CreateEncryptionZoneFlag#PROVISION_TRASH
   */
  PROVISION_TRASH((short) 0x01);

  private final short mode;

  CreateEncryptionZoneFlag(short mode) {
    this.mode = mode;
  }

  public static CreateEncryptionZoneFlag valueOf(short mode) {
    for (CreateEncryptionZoneFlag flag : CreateEncryptionZoneFlag.values()) {
      if (flag.getMode() == mode) {
        return flag;
      }
    }
    return null;
  }

  public short getMode() {
    return mode;
  }
}