Class

org.scalatest.exceptions

NotAllowedException

Related Doc: package exceptions

Permalink

class NotAllowedException extends StackDepthException

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.

Source
NotAllowedException.scala
Exceptions thrown

NullArgumentException if either message or failedCodeStackDepthFun is null

Linear Supertypes
StackDepthException, StackDepth, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NotAllowedException
  2. StackDepthException
  3. StackDepth
  4. RuntimeException
  5. Exception
  6. Throwable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NotAllowedException(message: String, failedCodeStackDepthFun: (StackDepthException) ⇒ Int)

    Permalink

    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.

    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.

    message

    the exception's detail message

    failedCodeStackDepthFun

    a function that return the depth in the stack trace of this exception at which the line of code that attempted

    Exceptions thrown

    NullArgumentException if message is null

  2. new NotAllowedException(message: String, failedCodeStackDepth: Int)

    Permalink

    Constructs a NotAllowedException with pre-determined message and failedCodeStackDepth.

    Constructs a NotAllowedException with pre-determined message and failedCodeStackDepth. (This was the primary constructor form prior to ScalaTest 1.5.)

    message

    the exception's detail message

    failedCodeStackDepth

    the depth in the stack trace of this exception at which the line of code that attempted something not allowed resides.

    Exceptions thrown

    NullArgumentException if message is null

  3. new NotAllowedException(message: String, pos: Position)

    Permalink

    Constructs a NotAllowedException with given error message and source position.

    Constructs a NotAllowedException with given error message and source position.

    message

    the exception's detail message

    pos

    the source position

  4. new NotAllowedException(message: String, cause: Option[Throwable], pos: Position)

    Permalink

    Constructs a NotAllowedException with given error message, optional cause and source position.

    Constructs a NotAllowedException with given error message, optional cause and source position.

    message

    the exception's detail message

    cause

    the optional cause

    pos

    the source position

  5. new NotAllowedException(message: String, cause: Option[Throwable], posOrStackDepthFun: Either[Position, (StackDepthException) ⇒ Int])

    Permalink

    message

    a string that explains the problem

    cause

    an optional cause

    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.

    Exceptions thrown

    NullArgumentException if either message or failedCodeStackDepthFun is null

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def canEqual(other: Any): Boolean

    Permalink

    Indicates whether this object can be equal to the passed object.

    Indicates whether this object can be equal to the passed object.

    Definition Classes
    NotAllowedExceptionStackDepthException
  6. val cause: Option[Throwable]

    Permalink

    an optional cause, the Throwable that caused this StackDepthException to be thrown.

    an optional cause, the Throwable that caused this StackDepthException to be thrown.

    Definition Classes
    StackDepthExceptionStackDepth
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(other: Any): Boolean

    Permalink

    Indicates whether this object is equal to the passed object.

    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.

    Definition Classes
    NotAllowedExceptionStackDepthException → AnyRef → Any
  10. def failedCodeFileName: Option[String]

    Permalink

    A string that provides the filename of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    A string that provides the filename of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    This is a def instead of a val because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by the SeveredStackTraces trait.

    returns

    a string containing the filename that caused the failed test

    Definition Classes
    StackDepth
  11. def failedCodeFileNameAndLineNumberString: Option[String]

    Permalink

    A string that provides the filename and line number of the line of code that failed, suitable for presenting to a user of the failing line.

    A string that provides the filename and line number of the line of code that failed, suitable for presenting to a user of the failing line. It calls failedCodeFileName and failedCodeLineNumber to get the failing filename and line number.

    failedCodeFileName and failedCodeLineNumber will fall back to exception stack trace when Position is not avaiable, this is the reason it is a def instead of a val, because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by the SeveredStackTraces trait.

    returns

    a user-presentable string containing the filename and line number that caused the failed test

    Definition Classes
    StackDepth
  12. lazy val failedCodeFilePathname: Option[String]

    Permalink

    A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.

    A string that provides the full pathname of the source file containing the line of code that failed, suitable for presenting to a user.

    returns

    a string containing the full pathname of the source file containing the line of code that caused this exception

    Definition Classes
    StackDepthExceptionStackDepth
  13. lazy val failedCodeFilePathnameAndLineNumberString: Option[String]

    Permalink

    A string that provides the absolute filename and line number of the line of code that failed, suitable for presenting to a user of the failing line.

    A string that provides the absolute filename and line number of the line of code that failed, suitable for presenting to a user of the failing line. It calls failedCodeFilePathname and failedCodeLineNumber to get the failing absolute filename and line number.

    returns

    a user-presentable string containing the absolute filename and line number that caused the failed test

    Definition Classes
    StackDepth
  14. def failedCodeLineNumber: Option[Int]

    Permalink

    A string that provides the line number of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    A string that provides the line number of the line of code that failed, suitable for presenting to a user, which is taken from this exception's StackTraceElement at the depth specified by failedCodeStackDepth.

    This is a def instead of a val because exceptions are mutable: their stack trace can be changed after the exception is created. This is done, for example, by the SeveredStackTraces trait.

    returns

    a string containing the line number that caused the failed test

    Definition Classes
    StackDepth
  15. lazy val failedCodeStackDepth: Int

    Permalink

    The depth in the stack trace of this exception at which the line of test code that failed resides.

    The depth in the stack trace of this exception at which the line of test code that failed resides.

    One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property will often be StackDepthExceptions, but whose failedCodeStackDepth will never be used. Another reason is to remove the need to create a different exception before creating this one just for the purpose of searching through its stack trace for the proper stack depth. Still one more reason is to allow the message to contain information about the stack depth, such as the failed file name and line number.

    Definition Classes
    StackDepthExceptionStackDepth
  16. def fillInStackTrace(): Throwable

    Permalink
    Definition Classes
    Throwable
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def getCause(): Throwable

    Permalink
    Definition Classes
    Throwable
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def getLocalizedMessage(): String

    Permalink
    Definition Classes
    Throwable
  21. def getMessage(): String

    Permalink

    Returns the detail message string of this StackDepthException.

    Returns the detail message string of this StackDepthException.

    returns

    the detail message string of this StackDepthException instance (which may be null).

    Definition Classes
    StackDepthException → Throwable
  22. def getStackTrace(): Array[StackTraceElement]

    Permalink
    Definition Classes
    Throwable
  23. def hashCode(): Int

    Permalink

    Returns a hash code value for this object.

    Returns a hash code value for this object.

    Definition Classes
    NotAllowedExceptionStackDepthException → AnyRef → Any
  24. final def initCause(throwable: Throwable): Throwable

    Permalink
    Definition Classes
    StackDepthException → Throwable
  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  26. lazy val message: Option[String]

    Permalink

    An optional detail message for this StackDepth exception.

    An optional detail message for this StackDepth exception.

    One reason this is lazy is to delay any searching of the stack trace until it is actually needed. It will usually be needed, but not always. For example, exceptions thrown during a shrink phase of a failed property will often be StackDepthExceptions, but whose message will never be used. Another related reason is to remove the need to create a different exception before creating this one just for the purpose of searching through its stack trace for the proper stack depth. Still one more reason is to allow the message to contain information about the stack depth, such as the failed file name and line number.

    Definition Classes
    StackDepthExceptionStackDepth
  27. val messageFun: (StackDepthException) ⇒ Option[String]

    Permalink

    a function that produces an optional detail message for this StackDepthException.

    a function that produces an optional detail message for this StackDepthException.

    Definition Classes
    StackDepthException
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. val position: Option[Position]

    Permalink

    An optional source position describing the line of test code that caused this exception.

    An optional source position describing the line of test code that caused this exception.

    Definition Classes
    StackDepthExceptionStackDepth
  32. def printStackTrace(arg0: PrintWriter): Unit

    Permalink
    Definition Classes
    Throwable
  33. def printStackTrace(arg0: PrintStream): Unit

    Permalink
    Definition Classes
    Throwable
  34. def printStackTrace(): Unit

    Permalink
    Definition Classes
    Throwable
  35. def setStackTrace(arg0: Array[StackTraceElement]): Unit

    Permalink
    Definition Classes
    Throwable
  36. def severedAtStackDepth: NotAllowedException

    Permalink

    Returns an exception of class NotAllowedException with failedExceptionStackDepth set to 0 and all frames above this stack depth severed off.

    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.)

    Definition Classes
    NotAllowedExceptionStackDepth
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def toString(): String

    Permalink
    Definition Classes
    Throwable → AnyRef → Any
  39. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StackDepthException

Inherited from StackDepth

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped