Provides ===
and !==
operators that return Boolean
, delegate the equality determination
to an Equality
type class, and require no relationship between the types of the two values compared.
Recommended Usage:
Trait TripleEquals is useful (in both production and test code) when you need determine equality for a type of object differently than its
equals method: either you can't change the equals method, or the equals method is sensible generally, but
you are in a special situation where you need something else. You can use the SuperSafe Community Edition compiler plugin to
get a compile-time safety check of types being compared with === . In situations where you need a stricter type check, you can use
TypeCheckedTripleEquals .
|
This trait will override or hide implicit methods defined by its sibling trait,
TypeCheckedTripleEquals
,
and can therefore be used to temporarily turn of type checking in a limited scope. Here's an example, in which TypeCheckedTripleEquals
will
cause a compiler error:
import org.scalactic._ import TypeCheckedTripleEquals._ object Example { def cmp(a: Int, b: Long): Int = { if (a === b) 0 // This line won't compile else if (a < b) -1 else 1 } def cmp(s: String, t: String): Int = { if (s === t) 0 else if (s < t) -1 else 1 } }
Because Int
and Long
are not in a subtype/supertype relationship, comparing 1
and 1L
in the context
of TypeCheckedTripleEquals
will generate a compiler error:
Example.scala:9: error: types Int and Long do not adhere to the equality constraint selected for the === and !== operators; they must either be in a subtype/supertype relationship; the missing implicit parameter is of type org.scalactic.Constraint[Int,Long] if (a === b) 0 // This line won't compile ^ one error found
You can “turn off” the type checking locally by importing the members of TripleEquals
in
a limited scope:
package org.scalactic.examples.tripleequals import org.scalactic._ import TypeCheckedTripleEquals._ object Example { def cmp(a: Int, b: Long): Int = { import TripleEquals._ if (a === b) 0 else if (a < b) -1 else 1 } def cmp(s: String, t: String): Int = { if (s === t) 0 else if (s < t) -1 else 1 } }
With the above change, the Example.scala
file compiles fine. Type checking is turned off only inside the first cmp
method that
takes an Int
and a Long
. TypeCheckedTripleEquals
is still enforcing its type constraint, for example, for the s === t
expression in the other overloaded cmp
method that takes strings.
Because the methods in TripleEquals
(and its siblings)override all the methods defined in
supertype TripleEqualsSupport
, you can achieve the same
kind of nested tuning of equality constraints whether you mix in traits, import from companion objects, or use some combination of both.
In short, you should be able to select a primary constraint level via either a mixin or import, then change that in nested scopes however you want, again either through a mixin or import, without getting any implicit conversion ambiguity. The innermost constraint level in scope will always be in force.
- Companion:
- object
- Source:
- TripleEquals.scala
Type members
Inherited classlikes
Class used via an implicit conversion to enable two objects to be compared with
===
and !==
with a Boolean
result and an enforced type constraint between
two object types. For example:
Class used via an implicit conversion to enable two objects to be compared with
===
and !==
with a Boolean
result and an enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
- Value parameters:
- leftSide
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with a Boolean
result and no enforced type constraint between
two object types. For example:
Class used via an implicit conversion to enable any two objects to be compared with
===
and !==
with a Boolean
result and no enforced type constraint between
two object types. For example:
assert(a === b) assert(c !== d)
You can also check numeric values against another with a tolerance. Here are some examples:
assert(a === (2.0 +- 0.1)) assert(c !== (2.0 +- 0.1))
- Value parameters:
- leftSide
An object to convert to
Equalizer
, which represents the value on the left side of a===
or!==
invocation.
- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Value members
Concrete methods
- Definition Classes
- Source:
- TripleEquals.scala
- Definition Classes
- Source:
- TripleEquals.scala
- Definition Classes
- Source:
- TripleEquals.scala
- Definition Classes
- Source:
- TripleEquals.scala
Deprecated methods
- Deprecated
- Definition Classes
- Source:
- TripleEquals.scala
- Deprecated
- Definition Classes
- Source:
- TripleEquals.scala
- Deprecated
- Definition Classes
- Source:
- TripleEquals.scala
- Deprecated
- Definition Classes
- Source:
- TripleEquals.scala
Inherited methods
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should !== (<pivot> +- <tolerance>)
”
syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should !== (<pivot> +- <tolerance>)
”
syntax of Matchers
.
- Value parameters:
- right
the
Spread[T]
against which to compare the left-hand value
- Returns:
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should !== null
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should !== null
” syntax
of Matchers
.
- Value parameters:
- right
a null reference
- Returns:
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should !== <right>
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should !== <right>
” syntax
of Matchers
.
- Value parameters:
- right
the right-hand side value for an equality assertion
- Returns:
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set tofalse
.- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should === (<pivot> +- <tolerance>)
”
syntax of Matchers
.
Returns a TripleEqualsInvocationOnSpread[T]
, given an Spread[T]
, to facilitate
the “<left> should === (<pivot> +- <tolerance>)
”
syntax of Matchers
.
- Value parameters:
- right
the
Spread[T]
against which to compare the left-hand value
- Returns:
a
TripleEqualsInvocationOnSpread
wrapping the passedSpread[T]
value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should === null
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[Null]
, given a null
reference, to facilitate
the “<left> should === null
” syntax
of Matchers
.
- Value parameters:
- right
a null reference
- Returns:
a
TripleEqualsInvocation
wrapping the passednull
value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should === <right>
” syntax
of Matchers
.
Returns a TripleEqualsInvocation[T]
, given an object of type T
, to facilitate
the “<left> should === <right>
” syntax
of Matchers
.
- Value parameters:
- right
the right-hand side value for an equality assertion
- Returns:
a
TripleEqualsInvocation
wrapping the passed right value, withexpectingEqual
set totrue
.- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Returns an Equality[A]
for any type A
that determines equality
by first calling .deep
on any Array
(on either the left or right side),
then comparing the resulting objects with ==
.
Returns an Equality[A]
for any type A
that determines equality
by first calling .deep
on any Array
(on either the left or right side),
then comparing the resulting objects with ==
.
- Returns:
a default
Equality
for typeA
- Inherited from:
- TripleEqualsSupport
- Source:
- TripleEqualsSupport.scala
Implicits
Implicits
- Definition Classes
- Source:
- TripleEquals.scala