scala.util.control.ControlThrowable.scala Maven / Gradle / Ivy

Go to download
/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2003-2010, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */


package scala.util.control

/**
 * A marker trait indicating that the Throwable it is mixed
 * into is intended for flow control.
 *
 * Note that Throwable subclasses which extend this trait
 * may extend any other Throwable subclass (eg.
 * RuntimeException) and are not required to extend
 * Throwable directly.
 * 
 * Instances of Throwable subclasses marked in
 * this way should not normally be caught. Where catch-all behaviour is
 * required ControlThrowables should be propagated, for
 * example,
 *
 *  *  import scala.util.control.ControlThrowable
 *
 *  try {
 *    // Body might throw arbitrarily
 * } catch {
 *   case ce : ControlThrowable => throw ce // propagate
 *   case t : Exception => log(t)           // log and suppress
 * 
 *
 * @author Miles Sabin
 */
trait ControlThrowable extends Throwable with NoStackTrace