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:
InfoProvided
reported with an:IndentedText( formattedText = "A Stack (when newly created)", rawText = "A Stack (when newly created)", indentationLevel = 0 )
TestSucceeded
reported with an: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
- 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 specifiedindentationLevel
is less than zero
- Alphabetic
- By Inheritance
- IndentedText
- Formatter
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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 specifiedindentationLevel
is less than zero
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- val formattedText: String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val indentationLevel: Int
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val rawText: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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()