org.scalatest.events

IndentedText

final case class IndentedText(formattedText: String, rawText: String, indentationLevel: Int) extends Formatter with Product with Serializable

A Formatter providing information that enables reporters to create more stylized output.

An example is that specification-style suites, such as FunSpec, generate output that reads more like a specification, for instance:

A Stack (when newly created)
- should be empty
- should complain when popped

This output might be generated by ScalaTest's standard out reporter. Each of these lines would be taken from the IndentedText's formattedText parameter. Were this same run to be reported in HTML or in a GUI, the output would be based on the rawText and the indentationLevel. Here's what the IndentedText values would be for each event:

One possible way this information could be presented in HTML, for example, is this:

A Stack (when newly created)

formattedText

a localized string suitable for presenting to a user by printing it straight to an output stream

rawText

a localized string suitable for presenting to the user after in some way being indented by the value specified as the indentationLevel parameter

indentationLevel

a zero or positive integer representing an indentation level for the indented text

Source
Formatter.scala
Exceptions thrown
IllegalArgumentException

if the specified indentationLevel is less than zero

Linear Supertypes
Serializable, Serializable, Product, Equals, Formatter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IndentedText
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Formatter
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IndentedText(formattedText: String, rawText: String, indentationLevel: Int)

    formattedText

    a localized string suitable for presenting to a user by printing it straight to an output stream

    rawText

    a localized string suitable for presenting to the user after in some way being indented by the value specified as the indentationLevel parameter

    indentationLevel

    a zero or positive integer representing an indentation level for the indented text

    Exceptions thrown
    IllegalArgumentException

    if the specified indentationLevel is less than zero

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. val formattedText: String

    a localized string suitable for presenting to a user by printing it straight to an output stream

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. val indentationLevel: Int

    a zero or positive integer representing an indentation level for the indented text

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. val rawText: String

    a localized string suitable for presenting to the user after in some way being indented by the value specified as the indentationLevel parameter

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  19. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Formatter

Inherited from AnyRef

Inherited from Any

Ungrouped