org.scalautils

Equalizer

class Equalizer[L] extends AnyRef

Class used via an implicit conversion to enable any two objects to be compared with === in assertions in tests. For example:

assert(a === b)

The benefit of using assert(a === b) rather than assert(a == b) is that a TestFailedException produced by the former will include the values of a and b in its detail message. The implicit method that performs the conversion from Any to Equalizer is convertToEqualizer in trait Assertions.

In case you're not familiar with how implicit conversions work in Scala, here's a quick explanation. The convertToEqualizer method in Assertions is defined as an "implicit" method that takes an Any, which means you can pass in any object, and it will convert it to an Equalizer. The Equalizer has === defined. Most objects don't have === defined as a method on them. Take two Strings, for example:

assert("hello" === "world")

Given this code, the Scala compiler looks for an === method on class String, because that's the class of "hello". String doesn't define ===, so the compiler looks for an implicit conversion from String to something that does have an === method, and it finds the convertToEqualizer method. It then rewrites the code to this:

assert(convertToEqualizer("hello").===("world"))

So inside a Suite (which mixes in Assertions, === will work on anything. The only situation in which the implicit conversion wouldn't happen is on types that have an === method already defined.

The primary constructor takes one object, left, whose type is being converted to Equalizer. The left value may be a null reference, because this is allowed by Scala's == operator.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Equalizer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Equalizer(left: L)

    left

    An object to convert to Equalizer, which represents the left value of an assertion.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. def !==(interval: Interval[L]): Boolean

  4. def !==(right: Any)(implicit equality: Equality[L]): Boolean

  5. final def ##(): Int

    Definition Classes
    AnyRef → Any
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def ===(interval: Interval[L]): Boolean

  9. def ===(right: Any)(implicit equality: Equality[L]): Boolean

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  22. def toString(): String

    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from AnyRef

Inherited from Any

Ungrouped