trait MapEqualityConstraints extends AnyRef
Provides an implicit method that loosens the equality constraint defined by TypeCheckedTripleEquals or ConversionCheckedTripleEquals
for Scala Maps to one that more closely matches Scala's approach to Map equality.
Scala's approach to Map equality is that if both objects being compared are Maps, the elements are compared to determine equality.
This means you could compare an immutable TreeMap and a mutable HashMap for equality, for instance, and get true so long as the two maps
contained the same key-value mappings. Here's an example:
scala> import scala.collection.immutable.TreeMap
import scala.collection.immutable.TreeMap
scala> import scala.collection.mutable.HashMap
import scala.collection.mutable.HashMap
scala> TreeMap("one" -> 1, "two" -> 2) == HashMap("one" -> 1, "two" -> 2)
res0: Boolean = true
Such a comparison would not, however, compile if you used === under either TypeCheckedTripleEquals or ConversionCheckedTripleEquals,
because TreeMap and HashMap are not in a subtype/supertype relationship, nor does an implicit conversion by default exist between them:
scala> import org.scalactic._
import org.scalactic._
scala> import TypeCheckedTripleEquals._
import TypeCheckedTripleEquals._
scala> TreeMap("one" -> 1, "two" -> 2) === HashMap("one" -> 1, "two" -> 2)
<console>:16: error: types scala.collection.immutable.TreeMap[String,Int] and
scala.collection.mutable.HashMap[String,Int] do not adhere to the equality constraint selected for
the === and !== operators; the missing implicit parameter is of type
org.scalactic.EqualityConstraint[scala.collection.immutable.TreeMap[String,Int],
scala.collection.mutable.HashMap[String,Int]]
TreeMap("one" -> 1, "two" -> 2) === HashMap("one" -> 1, "two" -> 2)
^
If you mix or import the implicit conversion provided by MapEqualityConstraint, however, the comparison will be allowed:
scala> import MapEqualityConstraints._
import MapEqualityConstraints._
scala> TreeMap("one" -> 1, "two" -> 2) === HashMap("one" -> 1, "two" -> 2)
res2: Boolean = true
The equality constraint provided by this trait requires that both left and right sides are subclasses of scala.collection.GenMap and that
an EqualityConstraint can be found for both key types and both value types. In the example above, both the TreeMap and
HashMap are subclasses of scala.collection.GenMap, and the regular TypeCheckedTripleEquals provides equality
constraints for the key types, both of which are String, and value types, both of which are Int. By contrast, this
trait would not allow a TreeMap[String, Int] to be compared against a HashMap[String, java.util.Date], because no equality constraint
will exist between the value types Int and Date:
scala> import java.util.Date
import java.util.Date
scala> TreeMap("one" -> 1, "two" -> 2) === HashMap("one" -> new Date, "two" -> new Date)
<console>:20: error: types scala.collection.immutable.TreeMap[String,Int] and
scala.collection.mutable.HashMap[String,java.util.Date] do not adhere to the equality constraint selected for
the === and !== operators; the missing implicit parameter is of type
org.scalactic.EqualityConstraint[scala.collection.immutable.TreeMap[String,Int],
scala.collection.mutable.HashMap[String,java.util.Date]]
TreeMap("one" -> 1, "two" -> 2) === HashMap("one" -> new Date, "two" -> new Date)
^
- Alphabetic
- By Inheritance
- MapEqualityConstraints
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit def mapEqualityConstraint[KA, VA, CA[ka, kb] <: GenMap[ka, kb], KB, VB, CB[kb, vb] <: GenMap[kb, vb]](implicit equalityOfA: Equality[CA[KA, VA]], evKey: CanEqual[KA, KB], evValue: CanEqual[VA, VB]): CanEqual[CA[KA, VA], CB[KB, VB]]
Provides an equality constraint that allows two subtypes of
scala.collection.GenMaps to be compared for equality with===so long as anEqualityConstraintis available for both key types and both value types. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()