IndentedText

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

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:

 IndentedText(
   formattedText = "A Stack (when newly created)",
   rawText = "A Stack (when newly created)",
   indentationLevel = 0
 )
 IndentedText(
   formattedText = "- should be empty",
   rawText = "should be empty",
   indentationLevel = 1
 )
  • TestSucceeded reported with an:
 IndentedText(
   formattedText = "- should complain when popped",
   rawText = "should complain when popped",
   indentationLevel = 1
 )

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

A Stack (when newly created)

  • should be empty

  • should complain when popped

Value parameters:
formattedText

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

indentationLevel

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

rawText

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

Throws:
IllegalArgumentException

if the specified indentationLevel is less than zero

class Formatter
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product