content: /*
   * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
   * (the "License"). You may not use this work except in compliance with the License, which is
   * available at www.apache.org/licenses/LICENSE-2.0
   *
   * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
   * either express or implied, as more fully set forth in the License.
   *
   * See the NOTICE file distributed with this work for information regarding copyright ownership.
   */
  
  package alluxio.stress.client;
  
  /**
   * The operations for the client io stress tests.
   *
   * There are 2 main types of reads: streaming and positioned.
   * The streaming reads do not take file offsets as part of the api, so a random, streaming read
   * is implemented with a seek() call before the read call. For positioned reads, the file offset
   * is an explicit parameter in the api, so no seek() calls are necessary to read from any file
   * offset.
   */
  public enum ClientIOOperation {
    /** The write operation, for writing data for the read operations. */
    WRITE("Write"),
  
    /** Streaming read api, using arrays. */
    READ_ARRAY("ReadArray"),
    /** Streaming read api, using byte buffers. */
    READ_BYTE_BUFFER("ReadByteBuffer"),
    /** Streaming read fully api. */
    READ_FULLY("ReadFully"),
    /** Positioned read api. */
    POS_READ("PosRead"),
    /** Positioned read fully api. */
    POS_READ_FULLY("PosReadFully"),
    ;
  
    /**
     * @param operation the operation
     * @return true if the operation is a read
     */
    public static boolean isRead(ClientIOOperation operation) {
      switch (operation) {
        case READ_ARRAY:
        case READ_BYTE_BUFFER:
        case READ_FULLY:
        case POS_READ:
        case POS_READ_FULLY:
          return true;
        default:
          return false;
      }
    }
  
    /**
     * @param operation the operation
     * @return true if the operation is a positioned read
     */
    public static boolean isPosRead(ClientIOOperation operation) {
      switch (operation) {
        case POS_READ:
        case POS_READ_FULLY:
          return true;
        default:
          return false;
      }
    }
  
    private final String mName;
  
    ClientIOOperation(String name) {
      mName = name;
    }
  
    @Override
    public String toString() {
      return mName;
    }
  
    /**
     * Creates an instance type from the string. This method is case insensitive.
     *
     * @param text the instance type in string
     * @return the created instance
     */
    public static ClientIOOperation fromString(String text) {
      for (ClientIOOperation type : ClientIOOperation.values()) {
        if (type.toString().equalsIgnoreCase(text)) {
          return type;
        }
      }
      throw new IllegalArgumentException("No constant with text " + text + " found");
    }
  }
  