alluxio-master-2.x/core/common/src/main/java/alluxio/exception/runtime/OutOfRangeRuntimeException.java
/*
 * 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.exception.runtime;

import alluxio.grpc.ErrorType;

import io.grpc.Status;

/**
 * Exception indicating that and operation was attempted past the valid range. E.g., seeking or
 * reading past end of file.
 *
 * Unlike InvalidArgument, this error indicates a problem that may be fixed if the system
 * state changes. For example, a 32-bit file system will generate InvalidArgument if asked
 * to read at an offset that is not in the range [0,2^32-1], but it will generate
 * OutOfRangeException if asked to read from an offset past the current file size.
 *
 * There is a fair bit of overlap between FailedPrecondition and OutOfRange. We
 * recommend using OutOfRange (the more specific error) when it applies so that callers who
 * are iterating through a space can easily look for an OutOfRange to detect when they are
 * done.
 */
public class OutOfRangeRuntimeException extends AlluxioRuntimeException {
  private static final Status STATUS = Status.OUT_OF_RANGE;
  private static final ErrorType ERROR_TYPE = ErrorType.User;
  private static final boolean RETRYABLE = false;

  /**
   * Constructor.
   *
   * @param message error message
   */
  public OutOfRangeRuntimeException(String message) {
    super(STATUS, message, null, ERROR_TYPE, RETRYABLE);
  }
}
