summaryrefslogtreecommitdiff
path: root/src/library/scala/util/control/ControlThrowable.scala
blob: 122b0c937a2da20bf7c79776ec66f984efbb6bf6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2003-2011, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */


package scala.util.control

/**
 * A marker trait indicating that the <code>Throwable</code> it is mixed
 * into is intended for flow control.
 *
 * <p>Note that <code>Throwable</code> subclasses which extend this trait
 * may extend any other <code>Throwable</code> subclass (eg.
 * <code>RuntimeException</code>) and are not required to extend
 * <code>Throwable</code> directly.</p>
 *
 * <p>Instances of <code>Throwable</code> subclasses marked in
 * this way should not normally be caught. Where catch-all behaviour is
 * required <code>ControlThrowable</code>s should be propagated, for
 * example,</p>
 *
 * <pre>
 *  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
 * </pre>
 *
 * @author Miles Sabin
 */
trait ControlThrowable extends Throwable with NoStackTrace