org.scalatest.events

IndentedText

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

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

An example is that specification-style suites, such as Spec, 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

attributes: final
Go to: companion

Inherits

  1. Product
  2. Equals
  3. Formatter
  4. AnyRef
  5. Any

Value Members

  1. def canEqual(arg0: Any): Boolean

  2. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Go to: companion
  3. val formattedText: String

  4. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    Go to: companion
  5. val indentationLevel: Int

  6. def productArity: Int

  7. def productElement(arg0: Int): Any

  8. def productElements: Iterator[Any]

  9. def productIterator: Iterator[Any]

  10. def productPrefix: String

  11. val rawText: String

  12. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    Go to: companion

Instance constructors

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

  2. new IndentedText()