trait Informer extends AnyRef
Trait to which custom information about a running suite of tests can be reported.
An Informer is essentially
used to wrap a Reporter and provide easy ways to send custom information
to that Reporter via an InfoProvided event.
Informer contains an apply method that takes a string and
an optional payload object of type Any.
The Informer will forward the passed message string to the
Reporter as the message parameter, and the optional
payload object as the payload parameter, of an InfoProvided event.
Here's an example in which the Informer is used both directly via info
method of trait FlatSpec and indirectly via the methods of
trait GivenWhenThen:
package org.scalatest.examples.flatspec.info
import collection.mutable import org.scalatest._
class SetSpec extends FlatSpec with GivenWhenThen {
"A mutable Set" should "allow an element to be added" in { given("an empty mutable Set") val set = mutable.Set.empty[String]
when("an element is added") set += "clarity"
then("the Set should have size 1") assert(set.size === 1)
and("the Set should contain the added element") assert(set.contains("clarity"))
info("That's all folks!") } }
If you run this SetSpec from the interpreter, you will see the following output:
scala> org.scalatest.run(new SetSpec)
A mutable Set
- should allow an element to be added
+ Given an empty mutable Set
+ When an element is added
+ Then the Set should have size 1
+ And the Set should contain the added element
+ That's all folks!
- Source
- Informer.scala
- Alphabetic
- By Inheritance
- Informer
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract def apply(message: String, payload: Option[Any] = None)(implicit pos: Position): Unit
Provide information and optionally, a payload, to the
Reportervia anInfoProvidedevent.Provide information and optionally, a payload, to the
Reportervia anInfoProvidedevent.- message
a string that will be forwarded to the wrapped
Reportervia anInfoProvidedevent.- payload
an optional object which will be forwarded to the wrapped
Reporteras a payload via anInfoProvidedevent.
- Exceptions thrown
NullArgumentExceptionifmessageorpayloadreference isnull
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()