org.scalatest.events

class IndentedText

[source: 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.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)

Parameters
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
Throws
IllegalArgumentException - 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
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.

Returns
the hash code value for the object.


override def toString : java.lang.String
Returns a string representation of the object.

The default representation is platform dependent.

Returns
a string representation of the object.


override def equals(arg0 : Any) : Boolean
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)).

Parameters
arg0 - the object to compare against this object for equality.
Returns
true if the receiver object is equivalent to the argument; false otherwise.


override def productPrefix : java.lang.String
Overrides
scala.Product.scala.Product.productPrefix

override def productArity : Int
Overrides
scala.Product.scala.Product.productArity

override def productElement(arg0 : Int) : Any
Overrides
scala.Product.scala.Product.productElement


Copyright (C) 2001-2010 Artima, Inc. All rights reserved.