org.scalatest.exceptions.NotAllowedException.scala Maven / Gradle / Ivy

/*
 * Copyright 2001-2013 Artima, Inc.
 *
 * Licensed 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.scalatest.exceptions

import org.scalactic.Requirements._
import org.scalactic.exceptions.NullArgumentException
import org.scalactic.source
import StackDepthExceptionHelper.posOrElseStackDepthFun

/**
 * Exception that indicates something was attempted in test code that is not allowed.
 * For example, in a FeatureSpec, it is not allowed to nest a feature
 * clause inside another feature clause. If this is attempted, the construction
 * of that suite will fail with a NotAllowedException.
 *
 * @param message a string that explains the problem
 * @param cause an optional cause
 * @param posOrStackDepthFun either a source position or a function that return the depth in the stack trace of this exception at which the line of code that attempted
 *    something not allowed resides.
 *
 * @throws NullArgumentException if either message or failedCodeStackDepthFun is null
 *
 * @author Bill Venners
 */
class NotAllowedException(
  message: String,
  cause: Option[Throwable],
  posOrStackDepthFun: Either[source.Position, StackDepthException => Int]
) extends StackDepthException((_: StackDepthException) => Some(message), cause, posOrStackDepthFun) {

  requireNonNull(message, cause, posOrStackDepthFun)

  /**
    * Constructs a NotAllowedException with given error message, optional cause and source position.
    *
    * @param message the exception's detail message
    * @param cause the optional cause
    * @param pos the source position
    */
  def this(
    message: String,
    cause: Option[Throwable],
    pos: source.Position
  ) = this(message, cause, Left(pos))

  /**
    * Constructs a NotAllowedException with given error message and source position.
    *
    * @param message the exception's detail message
    * @param pos the source position
    */
  def this(
    message: String,
    pos: source.Position
  ) = this(message, None, Left(pos))

  /**
   * Constructs a NotAllowedException with pre-determined message and
   * failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)
   *
   * @param message the exception's detail message
   * @param failedCodeStackDepth the depth in the stack trace of this exception at which the line of code that attempted
   *    something not allowed resides.
   *
   * @throws NullArgumentException if message is null
   */
  def this(message: String, failedCodeStackDepth: Int) =
    this(message, None, Right((_: StackDepthException) => failedCodeStackDepth))

  /**
   * Construct a NotAllowedException with pre-determined message and
   * a function that returns the depth in the stack trace of this exception at which the line of code that attempted.
   *
   * @param message the exception's detail message
   * @param failedCodeStackDepthFun a function that return the depth in the stack trace of this exception at which the line of code that attempted
   *
   * @throws NullArgumentException if message is null
   */
  def this(message: String, failedCodeStackDepthFun: StackDepthException => Int) =
    this(message, None, Right(failedCodeStackDepthFun))

  /**
   * Returns an exception of class NotAllowedException with failedExceptionStackDepth set to 0 and 
   * all frames above this stack depth severed off. This can be useful when working with tools (such as IDEs) that do not
   * directly support ScalaTest. (Tools that directly support ScalaTest can use the stack depth information delivered
   * in the StackDepth exceptions.)
   */
  def severedAtStackDepth: NotAllowedException = {
    val truncated = getStackTrace.drop(failedCodeStackDepth)
    val e = new NotAllowedException(message, None, posOrElseStackDepthFun(position, _ => 0))
    e.setStackTrace(truncated)
    e
  }

  /**
   * Indicates whether this object can be equal to the passed object.
   */
  override def canEqual(other: Any): Boolean = other.isInstanceOf[NotAllowedException]

  /**
   * Indicates whether this object is equal to the passed object. If the passed object is
   * a NotAllowedException, equality requires equal message,
   * cause, and failedCodeStackDepth fields, as well as equal
   * return values of getStackTrace.
   */
  override def equals(other: Any): Boolean =
    other match {
      case that: NotAllowedException => super.equals(that)
      case _ => false
    }

  /**
   * Returns a hash code value for this object.
   */
  // Don't need to change it. Implementing it only so as to not freak out people who know
  // that if you override equals you must override hashCode.
  override def hashCode: Int = super.hashCode
}