|
ScalaTest 1.0
|
|
org/scalatest/events/IndentedText.scala]
case final
class
IndentedText(val formattedText : java.lang.String, val rawText : java.lang.String, val indentationLevel : Int)
extends Formatter with scala.ProductFormatter 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:
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)
formattedText - a localized string suitable for presenting to a user by printing it straight to an output streamrawText - a localized string suitable for presenting to the user after in some way being indented by the value specified as the indentationLevel parameterindentationLevel - a zero or positive integer representing an indentation level for the indented textIllegalArgumentException - if the specified indentationLevel is less than zero| Method Summary | |
override def
|
equals
(arg0 : Any) : Boolean
This method is used to compare the receiver object (
this)
with the argument object (arg0) for equivalence. |
override def
|
hashCode
: Int
Returns a hash code value for the object.
|
override def
|
productArity : Int |
override def
|
productElement (arg0 : Int) : Any |
override def
|
productPrefix : java.lang.String |
override def
|
toString
: java.lang.String
Returns a string representation of the object.
|
| Methods inherited from AnyRef | |
| getClass, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized |
| Methods inherited from Any | |
| ==, !=, isInstanceOf, asInstanceOf |
| Method Details |
override
def
hashCode : Int
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.
override
def
toString : java.lang.String
The default representation is platform dependent.
this)
with the argument object (arg0) for equivalence.
The default implementations of this method is an equivalence relation:
x of type Any,
x.equals(x) should return true.x and y of type
Any, x.equals(y) should return true if and only
if y.equals(x) returns true.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.true if the receiver object is equivalent to the argument; false otherwise. override
def
productPrefix : java.lang.String
override
def
productArity : Int
|
ScalaTest 1.0
|
|